User Tools

Site Tools


general_information

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
general_information [2017/02/07 22:49]
gobrosse created
general_information [2018/01/25 11:43] (current)
gobrosse
Line 1: Line 1:
-===== Chunk Stories conventions ​=====+====== Documentation::​General Information ======
  
-It'​s ​probably important to specify ​few conventions ​that Chunk Stories uses.+**The obvious statement: This game is openly Minecraft-inspired.** There is no getting away from this and let'​s ​make it clear from the word go, without the historic strides Minecraft made, this project would have never existed. Minecraft, for all it's terrible technical issues and lame commercial derivatives lately, is one hell of great game and ChunkStories is a project ​that I started as a former passionate modder, frustrated with the state and lack of care the game developers had for a proper modding API.
  
-==== Master & Client ​====+===== Technology used =====
  
-In the code and engine internalsyou can see such nomenclature ​:WorldClient,​ WorldMaster,​ isMaster() etc ...+ChunkStories is built in Javausing the glorious [[http://lwjgl.org|LWJGL3]] library that provides us access to OpenGL and OpenALThe 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 sound engine and switched to JOML for better performance in summer 2017.
  
-//Client// means 'Is an end-user : it can render the worldcontrol entities etc' +The game boasts client/server model and is designed with moddingiteration and experimentation as major goals. The default shaders and rendering pipeline implements a deferred rendererwith support for SSAO, SSR, HDR, bloom, environment mapping and shadow mapping. The API *is* open-source, ​and is freely available ​on my Github page, along with a good chunk of example content.
-//Master// means 'Runs the world logicmanages end-users and has the authority ​on it'+
  
-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.+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.
  
-==== 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 block**I**D,​ 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\\ 
- 
-==== File formats ==== 
- 
-  * Chunk Stories uses exclusively 32-bit PNGs as image formats.\\ 
-  * All configuration files are text files encoded using UTF-8\\ 
-  * Models for entities may use a special configuration of the .obj format and bvh bone animation files.\\ 
-  * OGG Vorbis is our format of choice for audio. 
general_information.1486504196.txt.gz · Last modified: 2017/02/07 22:49 by gobrosse