User Tools

Site Tools


general_information

**This is an old revision of the document!**

Documentation::General Information

DISCLAIMER: This game only exists because of Minecraft. There is no getting away from this and let's make it clear from the word go, without the historic strides Minecraft made to the video game medium, this project would have never existed. Minecraft, for all it's terrible technical issues and lame commercial derivatives overexploitations, is one hell of a great game and ChunkStories is a project that I started as a former modder, frustrated with the state and lack of care the game developers had for a proper modding API.

Technology used

ChunkStories is built in Java, using the glorious LWJGL library that provides us access to OpenGL and OpenAL. The JOrbis Library is used for OGG Vorbis deconding, Jansi is used for pretty console commandline on the server and lz4 is the library used to compress our data. Vecmath and slick-utils were refactored out in early 2016 of the codebase and ChunkStories now has it's own minimalistic Vector/Algebra library and sound engine.

The game boasts client/server model and is designed with modding, iteration and experimentation as major goals. The default shaders and rendering pipeline implements a deferred renderer, with support for SSAO, SSR, HDR, bloom, environment mapping and shadow mapping. It makes use of Java's qualities when it comes to runtime code loading and decent portability, and will run on Windows XP to 10 (somewhat tested at the edges, don't come crying if your EOL Vista x32 notebook has issues with it's ATI drivers from 2009), Linux (Debian and derivatives are fine and other distros should be good too) and MacOS X, depending on the mood of the Apple shader compiler.

The game is built using Eclipse, Git, Paint.NET, Notepad++, PuTTY, WinSCP, Firefox, Blender and Audacity. I use VisualVM, RenderDoc, apitrace and AMD PerfStudio to do debugging, as well as WireShark occasionally. This wiki runs using DokuWiki. Huge props to the maker of these free softwares that truly make my life good !

Conventions

It's probably important to specify a few conventions that Chunk Stories uses.

Master & Client

In the code and engine internals, you can see such nomenclature :WorldClient, WorldMaster, isMaster() etc …

Client means 'Is an end-user : it can render the world, control entities etc' Master means 'Runs the world logic, manages end-users and has the authority on it'

I did not use 'client' and 'server' for good reasons : there is no reason a client can't also be a master : this situation happens when you have a local singleplayer or multiplayer world running on the bare client.

6 Axises

These axises are used face-related operation such as block selection or culling.

  • 0 LEFT (X-)
  • 1 FRONT (Z+)
  • 2 RIGHT (X+)
  • 3 BACK (Z-)
  • 4 TOP (Y+)
  • 5 BOTTOM (Y-)

As you can see, the Y axis is height, X is east-west and Z north-south.

Voxel cell data setup

The engine stores all voxels in 32-bit signed ( Java won't allow unsigned :c ) ints, packed in 32x32x32 cubical chunks, packed themselves in 8x8x8 regions.

These ints are composed as : 0x0BSMIIII

0→15 16-bit I blockID, allowing for 65536 different blocks types
16→19 4-bit M Metadata for simple objects and Minecraft porting
20→23 4-bit S Sun light from the sun
24→28 4-bit B Block light, “yellowish” light from torches etc
29→31 4-bit 0 Free if you feel brave

general_information.1486507092.txt.gz · Last modified: 2017/02/07 23:38 by gobrosse