buldthensnip/docs/setup_json.txt
2013-04-25 12:21:35 -07:00

123 lines
3.7 KiB
Plaintext

There are two files you'll need to look at.
- clsave/config.json configures the game engine.
- clsave/pub/user.json configures your profile.
For more information on the JSON syntax, check out this website:
http://json.org/
-------------------------------------------------------------------------------
Basic introduction:
clsave/config.json:
"video" section:
"width" and "height" define the width and height of the
screen/window.
"fullscreen" can be either true or false (not in "quotes"!)
You must either use a 24bpp or 32bpp screen mode.
No 15/16bpp, sorry! And DEFINITELY NO 8BPP.
"cubeshift" is for quality control.
Increase it one at a time if it's slow.
Decrease it one at a time if it looks awful.
"1" is recommended, although it looks pixelated when you zoom in.
Note, "cubeshift" does not affect the OpenGL renderer.
"antialiasinglevel" sets antialiasing level for OpenGL
"0" disable antialiasing (safe option for older hardware)
"2" set multisamples to 2
"4" set multisamples to 4
The higher number, the better quality.
The better quality, the slower.
"smoothlighting" enables the display of smooth dark corners and
shadows between cubes.
Disable for a faster FPS.
"gl_chunk_size" sets the size of the map chunks in OpenGL mode
The bigger chunks are, the more time it will take to rebuild them when
modified.
Recommended value is 16.
"gl_visible_chunks" represent the number of cells of the chunks array
centered around the camera/player in OpenGL mode.
It is linked to gl_chunk_size and the fog distance.
It should be a odd square number to construct a circular array with a
center cell (9, 25, 49, 81, 121...).
For the current fog distance, and a gl_chunk_size of "16", the
recommended value is "49".
"gl_chunks_tesselated_per_frame" number of chunks to tessellate per
frame.
The more chunks are tesselated per frame, the more stutter may be
encountered.
A recommended value would be "2" (or "1" for slower computers).
"vbo" enables vertex buffer objects (default: true)
May fail on older computers. Enable for a faster FPS.
"audio" section:
"freq" is the master audio sampling frequency in Hz, as usual.
"channels" is how many channels you can output to;
typically you'll leave this at 2 for stereo.
"bits" is how many bits per sample - must be 16 or 8.
"volume" is a volume multiplier.
Best to leave this at 1.0.
clsave/pub/user.json:
"name" should be set to something other than null;
otherwise, the game will give you a really demeaning name.
"kick_on_join" should be false;
otherwise, you won't even be able to get in.
"sensitivity" is mouse sensitivity.
it takes 1000/sensitivity pixels to rotate by 180 degrees.
"skins" is explained later in this document.
"bio" is explained later in this document.
-------------------------------------------------------------------------------
Biography:
These fields are defined:
"description": How you would describe yourself.
"location": Where you are from.
"languages": What languages you speak (an array).
Servers may choose to filter by language.
If you lie about these, expect to get blacklisted.
Current defined languages:
"de": Deutsch
"en": English
"es": Espanol
"fr": Francais
"kr": Korean (todo: find the local name for this)
"pl": Polski
"pt": Portuguese (todo: find the local name for this)
"se": Svenska
-------------------------------------------------------------------------------
Skins:
This is not defined yet.
-------------------------------------------------------------------------------
TODO: all the things!
-------------------------------------------------------------------------------