Merge pull request #9 from DaNubCoding/dev-v0.2.1

Dev v0.2.1

Author: Hex5DA

.gitignore

@@ -1,4 +1,5 @@
 build/profiles/*
-__pycache__/
+screenshots/*
 build/dist/*
+__pycache__/
 /.vscode

CHANGELOG.md

@@ -1,191 +1,104 @@
-# Version 0.2.0
+# Version 0.2.1
 
-Version 0.2.0 is a major update that focuses primarily on underground generation and features.
-Other notable changes include pickblock, block selection, better particles and profiling.
+0.2.1 is a minor update following 0.2.0 that focuses more on bug fixes, optimizations, code improvements, and expandability changes.
 
-## Additions
-
-### New blocks
-
-- Bedrock
-- Granite
-- Diorite
-- Andesite
-- Coal ore
-- Iron ore
-- Gold ore
-- Lapis ore
-- Redstone ore
-- Diamond ore
-- Emerald ore
-- Deepslate
-- Cobbled deepslate
-- Deepslate coal ore
-- Deepslate iron ore
-- Deepslate gold ore
-- Deepslate lapis ore
-- Deepslate redstone ore
-- Deepslate diamond ore
-- Deepslate emerald ore
-
-### Caves
-
-- Generated with Perlin Noise
-- You will sometimes find grass and dirt getting cut off without any actual cave generating, that is a quirk of cave generation
-- Caves will not be able to cut through bedrock
-
-Example:
-![img](https://imgur.com/riznmBD.png)
-
-### Stone Types
-
-- There are 4 new stone types:
-  - Granite
-  - Diorite
-  - Andesite
-  - Tuff
-- Granite, diorite, and andesite generate anywhere above deepslate level ( < chunk-y 64)
-- Tuff only generates below deepslate level ( > chunk-y 64)
-- Their shapes are determined by a Cellular Automata algorithm
-- They will not generate overlapping with ore veins, neither will they replace dirt, ores, nor bedrock
-
-### Bedrock + World Height
-
-- Bedrock generates from y 1024+
-- There is a blend between stone and bedrock, generated the same as stone -> deepslate
-- The player cannot break bedrock
-
-### Ore Veins
-
-- Ore vein shapes are determined by a Cellular Automata algorithm.
-- They will turn into deepslate variants of the ores if they generate replacing deepslate
-- Ores will not replace bedrock or dirt
-
-#### Distribution
-
-- They generate underground with the following distribution (all percentages represent the chance of generation per chunk):
-  - Coal ore (2 attempts per chunk) starts generating with a 16% chance at the top of the world, decreases until it reaches chunk-y 64, gets more common going down until chunk-y 96 with a 3% chance, then gets rarer until chunk-y 128
-  - Iron ore (2 attempts per chunk) starts generating at the top of the world rarely, quickly goes to 10% chance at chunk-y 8, then gets rarer as chunk-y goes down to 72
-  - Lapis ore (1 attempt per chunk) starts generating at chunk-y 32, gets more common until chunk-y 64 with a 6% chance, then gets rarer until chunk-y 96
-  - Gold ore (1 attempt per chunk) starts generating at chunk-y 56, gets more common until chunk-y 88 with a 7% chance, then gets rarer until chunk-y 120
-  - Redstone ore (2 attempts per chunk) starts generating at chunk-y 56, gets more common until chunk-y 120, then quickly gets rarer until chunk-y 128
-  - Diamond ore (1 attempt per chunk) starts generating at chunk-y 56, maintains a 1% chance of generating until chunk-y 96, then gets more common until chunk-y 128 with a 5% chance
-  - Emerald ore (1 attempt per chunk) starts generating at chunk-y 56, maintains a 1% chance of generating until chunk-y 72, then gets more common until chunk-y 96 with a 3% chance, then gets rarer until chunk-y 120
-
-Ore distribution map:
-![ore_dist](https://imgur.com/djtQs4s.png)
+---
 
-#### Best y-level for mining
+## Additions
 
-- The best chunk-y to mine for each ore, the attempts per chunk, and the chance per attempt:
-  - Coal: 2 (not 1 because a large portion of chunk-y 1 is made up of dirt), 16%, 2
-  - Iron: 8, 10%, 2
-  - Lapis: 64, 6%, 1
-  - Gold: 88, 7%, 1
-  - Redstone: 120, 15%, 2
-  - Diamond: 126 (not 128 or 127 because a large portion of them are made up of bedrock), 5%, 1
-  - Emerald: 96, 3%, 1
+### Screenshot
 
-### Particles
+- Press F2 to screenshot
+- The screenshot image will be stored in a folder named "screenshots" in the same directory as main.py
+- The image will be the same resolution as the resolution of the game (1200 x 600)
 
-#### Void Fog Particles
+### Cinematic Modes
 
-- Void fog particles start to spawn below y 896
-- The lower down the player is:
-  - The more particles spawn
-  - The bigger the particles on average
-- Void fog particles will be deleted if they either move behind a block or move outside the screen
+- To toggle cinematic modes, press F3
+- There are 4 option to toggle through in order:
+  - Show both the hotbar and crosshair
+  - Hide both
+  - Show crosshair but hide hotbar
+  - Show hotbar but hide crosshair
+- The current cinematic mode state will be shown by a popup displayed on the top-right
 
-#### Player Fall Particles
+### Hand Held Blocks
 
-- Player fall particles will be spawned when the player falls for more than or equal to 4 blocks and lands
-- The longer the player falls for, the most particles are spawned, to a maximum of 15 blocks
-- The particles will take the color of a random pixel of the block that the player fell onto
+- Blocks will now physically appear in the player's hand when the player is holding an item
 
-### Block Selection Box
+### Walking particles
 
-- Added a selection box around the block that the crosshair is hovering over
-- It is 2 pixels thick, and is offset towards the topleft corner by 2 pixels to fit the selected block entirely within the box
+- When the player walks at over 3 blocks per second, block particles would be spawned underneath its feet
 
-### Sky Gradient
-
-- The background colour now has a gradient between the default blue (y = 0-) and black (y = 1024)
+### 2DMC logo
 
-### Pick-block
+- 2DMC now has... a logo! It will be shown on the top left corner of the game window and in Alt + Tab menu!
+- You can see it below:
 
-- Press the MMB (middle mouse button) to pick the block the crosshair is hovering over
-- Some blocks cannot be pick-blocked, like bedrock, tall grass top, and leafed oak log
-- Pick-blocking will move the targeted block to the slot that you are selecting, no matter if it is on the hotbar or in the inventory
+![logo](https://imgur.com/UNfSbHV.png)
 
 ## Changes
 
-- Crosshair now fades between colors instead of instantly changing
-- Added "Block position" to the debug menu, which shows the coordinates of the block the crosshair is hovering over
-- Added "Particles" to the debug menu, which shows the number of particles that is being calculated
-- Added a transparent white overlay on the inventory slot that is being hovered over
-
-## Bug fixes
-
-- Fixed floating tall grass on chunk borders
-- Particles float upwards when inside a block, now they just fall out
-- Fixed tall grass being cut off by a tree on chunk borders
-
-## Technical changes
+- Optimized particles with conditional collision testing
+- Text boxes now show their outer border / rect whilst in debug mode
+- Velocity now shows up as BPS (blocks per second) in debug
+- Paperdoll no longer covers held item when in inventory
+- Optimized chunk loading and structure generation
+
+## Bug Fixes
+
+- Fixed particles occasionally falling into solid blocks
+- Fixed void fog particles spawning in extremely large numbers when the player enters the upper threshold of void fog particles
+- Fixed player being able to tunnel through blocks as FPS gets extremely low
+- Fixed player tunnelling when the window is moved, now, the game will just pause with dt being set to 0
+
+## Licensing
+
+- 2DMC is now an officially Open Source project!
+- It is licensed with the GNU General Public License v3
+- You can view the full license [here](LICENSE.md)!
+- All src/ files now have a short header to reflect this.
+
+## Technical Changes
+
+- Reworked the sprite system to allow better control over draw order, and to make the sprites easier to work with!
+  - We now have a custom defined sprite class
+    - This sprite class serves as a superclass for all other sprites, and provides a constructor and a number of methods that make all sprites compatible with our SpriteManager
+  - We have a SpriteManager class that manages draw order, updates and other useful management functions
+  - Draw order is defined in an automatic enumeration
+  - Sprites can have a custom debug layer (debug information is rendered on a different layer to the sprite) or a regular debug layer (debug information is rendered on the same layer as the sprite)
+  - If you want to get a better understanding of this system then you are best off looking at the code (particuarly [sprite.py](src/sprite.py)), be warned the code is kinda gross >.<
+
+- Velocity is now set and calculated with BPS (blocks per second)
+- We have implemented a Single Instance Superclass. This class ensures any subclasses can only have 1 instance of themselves at a time.
+  - This is useful, for example for the inventory labels, where whenever you move the mouse a new label will spawn. However, we only want one label to spawn at a time. Previously this required a very complicated and extremely ugly system of kill methods and class attributes and conditional checks which was, in short, [gross](https://github.com/DaNubCoding/2DMC/commit/21970ed4f93699bfecfa0e321f33f127ece247e4?diff=split#r70245084).
+  - This system removes the need for this. Any sprite that inherits from SingleInstance and calls it's constructor will have this handled automatically
+  - Demo (because the constructor is slightly confusing):
+
+  ```python
+  class Foo(Sprite, SingleInstance):
+    def __init__(self, layer: int | LayersEnum) -> None:
+      Sprite.__init__(self, layer)
+      SingleInstance.__init__(self, self) # The second self call passes the instance to SingleInstance, the first is just a __init__ thing ¯\_(ツ)_/¯
+  ```
 
-- Grouped code into different files in the "src" folder
-- Added comments, docstrings and type annotations explaining the code
-- Separated collision detection from camera because that is just very bad
-- Improved particle performance
-- Greatly improved chunk loading performance considering the new terrain features that have been added
-- The system by which we create, update and draw particles has been completely reworked.
-  - We are now using OOP in the inheritance tree:
+- We have implemented a new system called "Information Labels"
+  - These labels can be defined as "anything non-permanent that conveys information or any other content".
+  - This includes images, popups, labels, toasts, ect.
+  - Made a [information label class](src/information_label.py) to better how these labels are handled. Labels are considered sprites internally, and so can be given different layers
+  - Labels are designed with OOP in mind. As of 0.2.1 the inheritance tree is as follows:
 
   ```InheritanceTree
-    Particle
-    ├── PhysicsParticle
-    │   ├── BlockParticle
-    │   └── PlayerFallParticle
-    └── EnviromentalParticle
-        └──VoidFogParticle
+  InformationLabel
+  └── GenericTextBox
+      ├── InventoryLabelTextBox
+      └── HotbarLabelTextBox
   ```
 
-### Profiling
-
-- To make a profile for a function, pass the callable  into src.utils.profile, along with its parameters
-- It will create a .prof file in build/profiles on the function that has been passed when F9 is pressed
-- The file will have the time of creation in its file name
-
-In game you can presss F9 and it will generate a profile of `<callable>` in build/profiles.
-
-```python
-# variable = <callable>(<*args>)
-import src.utils as utils
-variable = utils.profile(<callable>, <*args>)
-```
-
-For instance, to time the loading of chunks, you could do the following:
-
-```python
-# self.rendered_chunks = load_chunks(self.player.camera)
-import src.utils as utils
-self.rendered_chunks = utils.profile(load_chunks, self.player.camera)
-```
-
-If you want to generate a profile without you having to press a key (for example,
-if you want to time a function if a certain condition is met), you could do the following:
-
-```python
-import src.utils as utils
-if <condition>:
-  utils.do_profile = True
-profile(<callable>, <*args>)
-```
-
-For instance, to time the loading time of a certain chunk at (x, y), you could do the following:
+  - NOTE: GenericTextBox also inherits from SingleInstance but this is hard to show on an inheritance tree.
 
-```python
-import src.utils as utils
-if chunk == (x, y):
-  utils.do_profile = True
-profile(Chunk, chunk)
-```
+- Structure generation and chunk loading is now done slightly differently
+  - Structure that extend into already existing chunks will simply place down the extra blocks directly into the neighboring chunk
+  - Base block generation is now cached by position
+  - Since perlin noise (which is used for cave generation) is very slow, it is now done once per loop instead of 64 times at once
+  - The cave heighmap will be generate block by block while chunks are not loading, so that when chunks load, the heightmap values have already been cached

CREDITS.md

@@ -8,7 +8,8 @@ Continued developement by DaNubCoding and onlyTr3v0r
 - Griffpatch: The original creation of Paper Minecraft (<https://scratch.mit.edu/projects/10128407>)!
 - Megalng: Structure generation (<https://stackoverflow.com/a/67558183/17303382>)
 - Rabbid76: ideas for solving a weird falling inconsistency bug (<https://stackoverflow.com/a/67437358/17303382>)
-- Hayyayson: original playtesting and overall support on the project
+- Hayyayson: playtesting and overall support on the project
 - Colby College Chemistry: Curve fitting website that was used for approximating a background gradient: (<https://www.colby.edu/chemistry/PChem/scripts/lsfitpl.html>)
-- sloth: A modified version of this colour changing formula was used for the crosshair (<https://stackoverflow.com/a/51979708/17303382>)
+- sloth: A modified version of this colour changing formula is used throughout the code (<https://stackoverflow.com/a/51979708/17303382>)
 - Alex Kruckman: A very useful post describing canter pairing (<https://math.stackexchange.com/a/23506>)
+- Cubekrowd's community: Overall advice throughout the project (<https://www.cubekrowd.net/>)