mirror of
https://github.com/italicsjenga/agb.git
synced 2024-12-23 16:21:33 +11:00
First draft at a changelog
This commit is contained in:
parent
a7e038aa18
commit
238b335aba
44
CHANGELOG.md
Normal file
44
CHANGELOG.md
Normal file
|
@ -0,0 +1,44 @@
|
|||
# Changelog
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
## [0.10.0] - 2022/07/31
|
||||
|
||||
Version 0.10.0 brings about many new features. As with most `agb` upgrades, you will need to update your `gba.ld` and `gba_mb.ld` files which you can find in the [template repo](https://github.com/agbrs/template). We would also recommend copying the `[profile.dev]` and `[profile.release]` sections from `Cargo.toml` if you don't have these values already.
|
||||
|
||||
### Added
|
||||
- Random number generator in agb::rng
|
||||
- Z-Ordering of sprites
|
||||
- Very basic font rendering - looking for feedback, this API is far from stable
|
||||
- Transparent sprite support with aseprite
|
||||
- 32kHz audio. Probably the best sound quality you'll get out of the hardware, but uses a lot of ROM space
|
||||
- Faster implementation of memcpy and memset thanks to the agbabi crate which provide a big performance boost for any project using agb
|
||||
- You can now write tests for projects depending on agb
|
||||
- Many functions previously undocumented are now documented
|
||||
- If you wish, you can now optionally do dynamic memory allocation to IWRAM instead of only EWRAM
|
||||
- [Hyperspace roll](https://lostimmortal.itch.io/hyperspace-roll), a new game built for the GMTK Game Jam 2022. The source code can be found in the `examples` directory.
|
||||
- You can now use 64x64px sprites
|
||||
- You can now configure the background size for tiled backgrounds
|
||||
- It is possible to create 'dynamic tiles' for backgrounds. These are tiles which are defined at runtime
|
||||
- Started using GitHub discussions as a forum
|
||||
|
||||
### Changed
|
||||
- Background tiles are now removed from VRam during `commit()` if they are no longer used rather than immediately reducing flickering
|
||||
- Audio system optimisations - reduced CPU usage by more than 50%
|
||||
- Improved the README for both the main agb crate and the template
|
||||
- The template now builds with optimisations in debug mode and debug symbols in release mode
|
||||
- Added `#[must_use]` to many of the places it is needed
|
||||
- All subcrates get released at once, so versions are kept in lockstep
|
||||
- A few methods accepting `Num<..>` have been changed to accept `impl Into<Num<..>>` to make them easier to use
|
||||
|
||||
### Removed
|
||||
- The ability to use timer0 and timer1 through the `timer` module. This was done in order to fully support 32kHz audio
|
||||
|
||||
### Fixed
|
||||
- Sprite data is now correctly aligned so fast copies will always work
|
||||
- A few methods which should really be internal have had `pub` removed
|
||||
- The crate now compiles (but does not run) doctests in CI which pointed out a large number of non-compiling examples
|
Loading…
Reference in a new issue