This readme is intended for developers. For downloads and gameplay instructions please see the official website
Vivecraft supports localization of its plethora of options and other strings. If you are multilingual and would like to help the project out, you can translate Vivecraft into your language of choice over on Transifex. If your target language is not on the list, you can put in a request for it to be added. Note that we can only support languages that Minecraft itself supports, which you can find a list of on the Minecraft wiki.
When translating tooltips (these are indicated by having .tooltip
at the end of the translation key) bear in mind that the tooltip box in-game has a fixed size and a limit of 8 lines, so if you write too much text it may be truncated. It can be difficult to judge where the limit is though since it depends on character width, so just guess and don't worry about it too much. There's a lot of extra space in most tooltips so it will likely be fine. Also, for tooltips that have a listing of what the option values do, the values on the left side of the colon should match what will appear on the button.
Some option names may appear to be vague and missing context. This is because context is provided by the category they are in. The names of these categories are found under the vivecraft.options.screen
keys.
If you see a §
in the text, that and the character immediately after it make a format code. Minecraft uses these to color or stylize text, you can read about them on the Minecraft wiki to understand the intent. Feel free to insert format codes to stylize text as you see fit.
If you're not sure about a particular translation, feel free to join our Discord server and ask about it.
Vivecraft uses patches to avoid distributing Minecraft code. The build scripts are in Python 2.X.
The install process (install.py) does a number of things:
If you use Eclipse you can open the workspace found in \mcp9xx\eclipse. You will have to correct the libraries (except jsr305) and JRE verssion, all of these can be found in the root /lib folder. To run the game from eclipse you also have to attach natives to the lwjgl jar (from lib/natives).
Make all changes to the game in the \mcp9xx\src\minecraft directory.