add diagrams

README.md

@@ -4,10 +4,9 @@ Modern stacker game with every polyominoes from size 1 to 15, made in C++ with [
 
 ## Download
 
-// TODO when the game is finished //
-
-This game has been tested on and built for Windows 11 and WSL2 Ubuntu.  
-If your OS isn't compactible with either of theses two, you can try [manually building the project](#manual-build).  
+You can download the latest release [here](https://git.ale-pri.com/TetrisNerd/jminos/releases)!  
+This game has been tested on Windows 11 and Linux, and releases are provided for theses two systems.  
+If your OS isn't compatible, you can try [manually building the project](#manual-build).  
 
 ## How to play
 
@@ -60,6 +59,8 @@ AutoRS demonstration
 This project uses xmake for compiling, xmake is cross-platform and works in most OS, xmake also automatically install supported librairies.  
 To be able to build this project, you need to [have xmake installed](https://xmake.io) and have a compiler with C++20 compatibility.  
 
+If you want to contribute or are simply curious, you can check the [wiki](https://git.ale-pri.com/TetrisNerd/jminos/wiki)!  
+
 ### Build the project
 
 ``cd jminos``
@@ -69,6 +70,9 @@ To be able to build this project, you need to [have xmake installed](https://xma
 If you need to change the toolchain (for example using gcc):  
 ``xmake f --toolchain=gcc``
 
+If you want to build for another platform (for example with mingw):  
+``xmake f -p mingw``
+
 ### Run the project
 
 ``xmake run``  
@@ -86,7 +90,13 @@ The command line version is **not** updated.
 
 ### Package the project
 
-// TODO when the game is finished //
+To package the executable manually properly, follow theses steps:  
+
+1. Clone the project into a new folder.
+2. If you already have all 15 pieces files, copy them over to the ``data/pieces`` folder, else you will be generating them at the next step.
+3. Go into release mode (``xmake f -m release``) and run the project once (``xmake`` and ``xmake run``). This is to generate the default config files, close the game immediately after it started.
+4. Make a new folder named ``jminos`` and copy the executable (should be located somewhere like ``build/linux/x86_64/release/graph``) as well as the ``data/pieces`` and ``data/config`` folders.
+5. Zip the newly created ``jminos`` folder into a file named ``jminos_{platform}``.
 
 ## Benchmarks
 
@@ -112,7 +122,6 @@ The command line version is **not** updated.
 
 _File storing includes type checking and sorting all polyominoes before writing them to the file._  
 The files are compressed, they used to be about 5x as large.  
-If you want to know more details about the generation and storage of polyominoes, [check the documentation](/doc/)!  
 
 Run it yourself by typing:  
 ``xmake f -m release``  
@@ -128,4 +137,4 @@ Inspired by other modern stacker games such as Techmino, jstris, tetr.io, etc.
 This game isn't affiliated with any of them.  
 
 Special thanks to my friend [Simon](https://git.ale-pri.com/Persson-dev) who did most of the outside stuff (github actions, files compression, asset manager, xmake).  
-All the code in src/Common and src/Utils comes from him.  
+All the code in src/Common/, src/Utils/ and xmake/ comes from him.  

doc/files_format.md

@@ -2,11 +2,11 @@
 
 ## Pieces
 
-If you don't know what a polyomino is, check [this other file](Pieces_representation.md#what-are-polyominoes).
+_Note: the current algorithm has been adapted to use file compression. There is currently no documentation on how the compression work, but you can check the code in the [src/Common](https://git.ale-pri.com/TetrisNerd/jminos/src/branch/main/src/Common) folder._
 
 Generating polyominoes of size n is exponential in regard to n. Because of this, we will store the pieces beforehand and load them upon launching the game.
 
-We want the pieces to be always sorted in the same order, always attributed the same block type, and always set at the same spawn position, no matter how they were generated. We also want them to be separated in 3 categories : convex, not convex but without a hole, and with a hole. Theses problematics are already resolved internally, but will be calculated before storage as to not need extra calculcations upon load (except for the block type which is trivially computed).
+We want the pieces to be always sorted in the same order, always attributed the same block type, and always set at the same spawn position, no matter how they were generated. We also want them to be separated in 3 categories : convex, not convex but without a hole, and with a hole. Theses problematics are already solved internally, but will be calculated before storage as to not need extra calculcations upon load (except for the block type which is trivially computed).
 
 Pieces are stored in binary files. Each file simply contains every polyomino of one size, one after the other. Since each file contains all polyominoes of the same size, we know how much stuff to read and don't need delimiters. We know we've read all pieces simply when we reach the end of file character.
 
@@ -55,5 +55,4 @@ The settings file has the following format:
     - For every single piece, use 1 byte for (the size + encoding that it is a single piece),
     and 3 bytes to store the number of the piece (allows number up to 16M, size 15 has 6M pieces).
 
-The current file format version is 11.
-If the file starts with a number lower than that, it will be regenerated upon launching the game.
+When starting the game, it will verify if the current settings file is in the latest format, if it is not it will be regenerated with default values.

doc/game_logic.md

@@ -1,7 +1,7 @@
 # Game logic
 
 This section will detail how the player's action are interpreted into the game.  
-We will only talk about pieces and not polyominoes. In this project, pieces are an abstraction of a polyomino. Though if you want to know more the polyominoes in this project, check [this other file](Pieces_representation.md).
+We will only talk about pieces and not polyominoes. In this project, pieces are an abstraction of a polyomino.
 
 ## Order of operations
 

src/Benchmark/main.cpp

@@ -49,14 +49,14 @@ void benchmarking(int min_size, int max_size) {
         ms_double = t2 - t1;
         std::cout << " | " << polyominoes.size();
         std::flush(std::cout);
-        std::cout << " | " << (int) ms_double.count() / 1000 << "s " << std::fmod(ms_double.count(), 1000) << "ms ";
+        std::cout << " | " << (int) ms_double.count() / 1000 << "s " << std::fmod(ms_double.count(), 1000) << "ms";
         std::flush(std::cout);
 
         t1 = high_resolution_clock::now();
         ok = pf.savePieces(i, polyominoes);
         t2 = high_resolution_clock::now();
         ms_double = t2 - t1;
-        std::cout << " | " << (int) ms_double.count() / 1000 << "s " << std::fmod(ms_double.count(), 1000) << "ms ";
+        std::cout << " | " << (int) ms_double.count() / 1000 << "s " << std::fmod(ms_double.count(), 1000) << "ms";
         std::flush(std::cout);
 
         if (!ok) {
@@ -76,7 +76,7 @@ void benchmarking(int min_size, int max_size) {
         ok = pf.loadPieces(i, pieces, convexPieces, holelessPieces, otherPieces);
         t2 = high_resolution_clock::now();
         ms_double = t2 - t1;
-        std::cout << " | " << (int) ms_double.count() / 1000 << "s " << std::fmod(ms_double.count(), 1000) << "ms ";
+        std::cout << " | " << (int) ms_double.count() / 1000 << "s " << std::fmod(ms_double.count(), 1000) << "ms";
         std::flush(std::cout);
 
         if (!ok) {