Skip to content

Commit

Permalink
Added README and LICENSE
Browse files Browse the repository at this point in the history
  • Loading branch information
agg23 committed Feb 7, 2021
1 parent 1d964d0 commit cec5d08
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2021 Adam Gastineau

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# FINes - Aquarium simulator for NES

FINes (pronouced finesse) is an aqaurium simulator for the NES, built in [Millfork](https://github.com/karols/millfork). The game is designed around the delicate balance of maintaining a freshwater aquarium, where the fish, plants, and water quality all feed into the health and lifetime of your fish. Fail to maintain that finesse and you will lose all of your fish and have to start over.

This game was originally built in the weeks between Dec. 30, 2020 and Feb. 28, 2021, with the intention of entering the [NESDev 2020/21 competition](http://forums.nesdev.com/viewtopic.php?f=36&t=21635&sid=cc42256defb11c0f5b4f57860637183b). Due to the competition requiring interoperability with the Action 53 multicart production, several notable features are missing from the current builds. The game is using CNROM (mapper 3), which does not have support for WRAM (save RAM), which limits the scope and expected playtime of the game to be more "arcade-like".

Following the competition, the game will be expanded to support saving, more fish, plants, and boons, and several other features.

## Features

- [x] Fish movement and schooling (rough, see Known issues)
- [x] Fish and plant purchasing in a centralized shop
- [x] Plant placement
- [x] Fish stat and health inspection
- [x] Fish selling
- [x] Fish breeding (rough, see known issues)
- [ ] Fish feeding
- [ ] Spectator mode (runs fish movement and animation, but disables the health, growth, and breeding mechanics)
- [ ] Plant removal/selling
- [ ] Boons and cosmetics
- [ ] Health mechanics
- [ ] Music and sound effects

0 comments on commit cec5d08

Please sign in to comment.