Skip to content

Commit

Permalink
little doc improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
UtoECat committed Feb 1, 2024
1 parent f6295b9 commit 312f505
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 3 deletions.
12 changes: 12 additions & 0 deletions base/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,15 @@ functions/libraries/systems all over the place :
- Constexpr Endian detection (TODO: may not work anymore on C++23)
- Resources for multithreading (local to get resource, destruction does unlock mutex)
- Scopeguard to add quick RAII types without much of boilerplate
- Highly used Base classes :
- Static - object is non-moable and non-copyable. Important when you keep references/pointers on it.
- Copyable - default one. Move and copy construction and assignment are allowed
- Moveable - only move construction and assignment are allowed
- Abstract (or virtual) - self explanotary. Used when RTTI is required or proper destruction.
- `Shared<T>` - basically it's std::enable_shared_from_this<T>
- Default (Deprecatd) - used in some places, == Moveable. Do not use it, should be removed soon
- HString - string with a hash inside. Kinda wonky, not always properly recalculates hash, but very useful
- locale-independent strtod()

# todo
- Locale and implementation-independent vsnprintf() :p
12 changes: 12 additions & 0 deletions engine/readme.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
# engine
here are all basic game types and systems are placed + all unique stuff to make it work.
Rendering is placed separately, because there should be no rendering on the server :) .

## enet wrapper
todo

## luau
todo in far future

## database
basic sqlite wrapper with some useful functions

## vfs
not implemented properly still. TODO: rename to asset manager
6 changes: 3 additions & 3 deletions game/version.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@
namespace pb {

static constexpr int VERSION_MAJOR = 0;
static constexpr int VERSION_MINOR = 8;
static constexpr int VERSION_PATCH = 8;
static constexpr int VERSION_MINOR = 9;
static constexpr int VERSION_PATCH = 1;

static constexpr std::string VERSION_STR = "0.9.0";
static constexpr std::string VERSION_STR = "0.9.1";

};

0 comments on commit 312f505

Please sign in to comment.