Skip to content

Commit

Permalink
doc/Utilities.md and Changelog.md update
Browse files Browse the repository at this point in the history
Former-commit-id: 88c41dc
  • Loading branch information
mwydmuch committed Aug 27, 2016
1 parent 6fdd4ee commit d123bf6
Show file tree
Hide file tree
Showing 11 changed files with 519 additions and 308 deletions.
56 changes: 34 additions & 22 deletions doc/Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,41 +4,53 @@

#### Buffers

* Depth buffer is now separate buffer in state and `ScreenFormat` values with it was removed - `is/setDepthBufferEnabled` added.
* Added in frame actors labeling feature -`is/setLabelsBufferEnabled` added.
* Added buffer with in game automap - `is/setAutomapBufferEnabled`, `setAutomapMode`, `setAutomapRoate`, `setAutomapRenderTextures`, `AutomapMode` enum added.
- Depth buffer is now separate buffer in state and `ScreenFormat` values with it was removed - `is/setDepthBufferEnabled` added.
- Added in frame actors labeling feature -`is/setLabelsBufferEnabled` added.
- Added buffer with in game automap - `is/setAutomapBufferEnabled`, `setAutomapMode`, `setAutomapRoate`, `setAutomapRenderTextures`, `AutomapMode` enum added.


#### GameState

* `getState` will now return `nullptr/null/None` if game is in the terminal state.
* `imageBuffer` renamed to `screenBuffer`.
* Added `depthBuffer`, `labelsBuffer` and `automapBuffer` and `labels` fields.
- `getState` will now return `nullptr/null/None` if game is in the terminal state.
- `imageBuffer` renamed to `screenBuffer`.
- Added `depthBuffer`, `labelsBuffer` and `automapBuffer` and `labels` fields.


#### Rendering options

* The option to use minimal hud instead of default full hud - `setRenderMinimalHud` added.
* The option to enable/disable effects that use sprites - `setRenderEffectsSprites` added.
* The option to enable/disable ingame messages independently of the console output - `setRenderMessages` added.
- The option to use minimal hud instead of default full hud - `setRenderMinimalHud` added.
- The option to enable/disable effects that use sprites - `setRenderEffectsSprites` added.
- The option to enable/disable ingame messages independently of the console output - `setRenderMessages` added.


#### Episode recording and replaying
...

- The option to record and replaying episodes, based on adapted ZDoom's demo mechanism -
recording `filePath` argument added to `newEpisode`, `replayEpisode` added.
- The option to replay demo from other player perspective.

#### Ticrate
* The option to set number of tics executed per second in ASNYC Modes.

#### Config loading
...
- The option to set number of tics executed per second in ASNYC Modes.
- New `ticrate` optional argument in `DoomTicsToMs`, `MsToDoomTics`.
- `DoomTicsToSec` and `SecToDoomTics` added.


#### Others
* ZDoom engine updated to 2.8.1
* Improved exceptions messages.
* Java exceptions handling fixed.
* Bugs associated with paths handling fixed.
* Many minor bugs fixed.

- ZDoom engine updated to 2.8.1
- Improved performance.
- Improved exceptions messages.
- Paths in config files are now relative to config file.
- Aliases for `DoomFixedToDouble` - `DoomFixedToNumber` in Lua and `doom_fixed_to_float` in Python added.
- Java exceptions handling fixed.
- Bugs associated with paths handling fixed.
- Many minor bugs fixed.


#### C++ specific

* A lot of overloaded methods turned into a methods with default arguments.
* `getState()` now returns `GameStatePtr (std::shared_ptr<GameState>)` instead of `GameState`.
* Buffers are now copied.
* GameState's buffer has now `BufferPtr (std::shared_ptr<Buffer>)` type - `Buffer (std::vector<uint8_t>)`.
- A lot of overloaded methods turned into a methods with default arguments.
- `getState()` now returns `GameStatePtr (std::shared_ptr<GameState>)` instead of `GameState`.
- Buffers are now copied.
- GameState's buffer has now `BufferPtr (std::shared_ptr<Buffer>)` type - `Buffer (std::vector<uint8_t>)`.
2 changes: 2 additions & 0 deletions doc/ConfigFile.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Configuration files

TODO

## Format

### Appending values
Expand Down
Loading

0 comments on commit d123bf6

Please sign in to comment.