# Contributing to VHMV
Anyone is free to help develop VH. We welcome artists, eventers, writers, translators, proofreaders...

## Process
At the moment, a contribution process has not yet been clearly defined. The porting of the existing content from VH01 is being done by the maintainers and is the priority. However, it has always been our goal to have the VH community involved in the development. When the time comes, this section will include a description of this process.

## Requirements
- Try to learn Git: [Git cheatsheet](https://about.gitlab.com/images/press/git-cheat-sheet.pdf)
- Ability to discuss and cooperate with other developers and especially with the maintainers
- Having played the game enough to understand the world of VH

## Content
### Translations / Proofreading
The MV edition of this game has been designed to include the translation of any language. The original language is japanese, and an english translation has been made. While the original japanese text is overall correct and shouldn't be modified too much, the english one is very flawed and most of the time has been made with machine translation.

We need proofreaders to help us review and fix the english translation.

It is perfectly possible to add new languages to the game.

Translations are located in `www/locales`.

#### Displaying a translated text


#### New languages

- Copy and paste the locale folder with the language you want to translate from 
- Rename the pasted folder with your language code (Ex: `es` for spanish)
- Add the new language in the plugin (`www/js/plugins.js`, or in the editor/plugins tab/DKTools_Localization)

#### Testing your translation

- Translate an example, the title menu text is in `RPG_RT_STRINGDATA.json` (Like key Sys-Terms-NewGame, line 95,  change the JSON value "New Game\n" only)
- You can change language outside the game by editing `www/save/locale.rpgsave` (change to your language code) or ingame if the devs added a language option
- Launch the game and check your changes for `New game` in the title menu

Please check the [translation style guide](TRANSLATION_STYLE_GUIDE.md) for information about how to format the translation and make it look the best for the game.

### Art
TBD

### Events
TBD

### Stories
TBD

## Development Guidelines
* Naming should be done in **english**. (Variables, switches, maps, events... everything that is in the editor and not shown to the player)
* Always name everything with something meaningful, don't leave the default names (Maps and events with IDs,...)
* Write comments, at least in long events
* Always prefer new event pages rather than creating common events (Unless it's a global and very used thing)
* Your commits should contain **only the least files possible** for a development (Map, mechanics, quest, story, translations...)
* Your commits messages should be **clear and briefly describe what they do** (Detail can go in description)
* Ask to **reserve** some variables / switches, to prevent conflicts with other developers
* Don't commit `MapInfos.json`, except for intended changes
* Don't commit the `.rpgproject` file
* Be careful about modifying `CommonEvents.json` and `System.json`, they can easily cause problems to other developers
* Only a selected few are maintainers, developers can create branches and ask maintainers to merge it in the main branch

### Content Guidelines
* Please stick as much to the VH01 content as possible
* Please don't make content that incite to hatred against stuff IRL
* As previously stated, no copyrighted material, make your own stuff
CONTRIBUTING.md