khanat-client/README.md

# Khanat

## Launch Game

### Download Version Godot

We use version GODOT : 3.3.3

wget https://downloads.tuxfamily.org/godotengine/3.3.3/Godot_v3.3.3-stable_x11.64.zip
unzip Godot_v3.3.3-stable_x11.64.zip

### Clone our project

Notice we use [git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) for this main repository, s you have to get them also.

git clone --recurse-submodules https://git.khaganat.net/khaganat/mmorpg_khanat/khanat-client.git
(cd khanat-client;git checkout develop)

### Launch Godot

./Godot_v3.3.3-stable_x11.64 khanat-client/project.godot

## Add/update your language

Welcome to help us to improve our translation.
We need clone our project.

### Create a new language

* On Linux :

Edit file : khanat-client/locale/locale.sh
(You need add in section [# LIST LANGUAGE] your locale)
After launch this script : bash khanat-client/locale/locale.sh

### Edit your local

khanat-client/locale/<your locale].po

keyword msgid is Id used in khanat, and msgstr is translation (if you have some doubt, don't hesitate to see other translation)

* msgid "MAIN_MENU_PLAY"
* msgstr "Jouer"

### Activate your language

Two option to activate (just use one)

1/ Use godot editor

in Parameter, localization, add your file

2/ Edit project.godot

Edit line :

translations=PoolStringArray( "res://locale/fr.po", "res://locale/en.po", "res//locale/<your language>.po" )


### Push your update 

To send your update, could you please create a branch and send us this branch?

### Git sub modules

This repository uses [submodule to git](https://git-scm.com/book/fr/v2/Utilitaires-Git-Sous-modules) :
- when updating the repository after merging, you will have to pass these commands to be sure you will get the submodules downloaded and updated. From your repository folder and in a branch where the submodules are being used, pass :
  - `git submodule init`
  - `git submodule update`
- you can pass the two in one : `git submodule update --init`
show menu after key <menu> pressed (default Escape) 2021-09-22 22:50:40 +00:00			`# Khanat`
adding icon jukebox 2021-06-22 16:22:58 +00:00
show menu after key <menu> pressed (default Escape) 2021-09-22 22:50:40 +00:00			`## Launch Game`

			`### Download Version Godot`

			`We use version GODOT : 3.3.3`

			`wget https://downloads.tuxfamily.org/godotengine/3.3.3/Godot_v3.3.3-stable_x11.64.zip`
update README and disable addons/kh_slider/plugin.cfg 2021-09-23 18:34:17 +00:00			`unzip Godot_v3.3.3-stable_x11.64.zip`
show menu after key <menu> pressed (default Escape) 2021-09-22 22:50:40 +00:00
			`### Clone our project`

Adding explanations about the use and cloning with submodules, mandatory from now on 2022-01-17 20:38:21 +00:00			`Notice we use [git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) for this main repository, s you have to get them also.`

			`git clone --recurse-submodules https://git.khaganat.net/khaganat/mmorpg_khanat/khanat-client.git`
update README and disable addons/kh_slider/plugin.cfg 2021-09-23 18:34:17 +00:00			`(cd khanat-client;git checkout develop)`
show menu after key <menu> pressed (default Escape) 2021-09-22 22:50:40 +00:00
			`### Launch Godot`

update README and disable addons/kh_slider/plugin.cfg 2021-09-23 18:34:17 +00:00			`./Godot_v3.3.3-stable_x11.64 khanat-client/project.godot`
show menu after key <menu> pressed (default Escape) 2021-09-22 22:50:40 +00:00
			`## Add/update your language`

			`Welcome to help us to improve our translation.`
			`We need clone our project.`

			`### Create a new language`

			`* On Linux :`

			`Edit file : khanat-client/locale/locale.sh`
			`(You need add in section [# LIST LANGUAGE] your locale)`
			`After launch this script : bash khanat-client/locale/locale.sh`

			`### Edit your local`

			`khanat-client/locale/<your locale].po`

update README and disable addons/kh_slider/plugin.cfg 2021-09-23 18:34:17 +00:00			`keyword msgid is Id used in khanat, and msgstr is translation (if you have some doubt, don't hesitate to see other translation)`

			`* msgid "MAIN_MENU_PLAY"`
			`* msgstr "Jouer"`

update README, and add section for language on script locale.sh 2021-09-23 20:39:13 +00:00			`### Activate your language`

			`Two option to activate (just use one)`

			`1/ Use godot editor`

			`in Parameter, localization, add your file`

			`2/ Edit project.godot`

			`Edit line :`

			`translations=PoolStringArray( "res://locale/fr.po", "res://locale/en.po", "res//locale/<your language>.po" )`


show menu after key <menu> pressed (default Escape) 2021-09-22 22:50:40 +00:00			`### Push your update`

			`To send your update, could you please create a branch and send us this branch?`
adding icon jukebox 2021-06-22 16:22:58 +00:00
Adding submodules usage indications 2021-10-17 19:53:05 +00:00			`### Git sub modules`

			`This repository uses [submodule to git](https://git-scm.com/book/fr/v2/Utilitaires-Git-Sous-modules) :`
Precision about the branch to be in for enabling git submodules 2021-10-17 20:16:48 +00:00			`- when updating the repository after merging, you will have to pass these commands to be sure you will get the submodules downloaded and updated. From your repository folder and in a branch where the submodules are being used, pass :`
Adding submodules usage indications 2021-10-17 19:53:05 +00:00			- `git submodule init`
			- `git submodule update`
Commands to init and update submodules in one line 2021-10-17 19:58:53 +00:00			- you can pass the two in one : `git submodule update --init`