diff --git a/README.md b/README.md index f5e26a5..1161c29 100644 --- a/README.md +++ b/README.md @@ -6,46 +6,12 @@ A game of Snake built using C# in the MonoGame framework, themed around everyone -## In Progress - -## Items to Develop - -## Done -- [x] Check every requirement on Canvas and make sure we have it implemented. -- [x] Play through with 3 clients (probably need to turn the movement speed way down to handle it)). Make sure the scores are working and that the leaderboard is correct. -- [x] Stress test the system and find bugs. Fix them. -- [x] Satchel: 3 different animated sprites for the spice -- [x] Satchel: Particle system for the death of a sandworm and eating food. -- [x] Max: Record players score, kills and highest position. -- [x] Max: Game over screen with score, kills, and highest position achieved. This is an overlay on the multiplayer game behind it. -- [x] Max: Leaderboard to display top 5 players and client's score in corner of game. -- [x] Max: Sync the anchor points across clients. -- [x] Max: Collision message and its wiring for the client to then render its own effects. -- [x] Max: The new player should join as an invincible entity. Add this functionality and a system to update it after 3 seconds to be removed from the entity. -- [x] Max: On collision, sandworm breaks apart and is available as food for other snakes -- [x] Max: Grow the worm on eating food. -- [x] Satchel: Loading Screen while joining the game -- [x] Caden: Spice generation when we spawn -- [x] Caden: Periodic spice generation throughout the game -- [x] Max: Collision Detection system. -- [x] Max: Keyboard support for the left, right, up, down, diagonal up left and diagonal up right. Also, add these to the wormMovement system. -- [x] Max: Snake Movement with the queue system -- [x] Max: Upgrade our movement system to reduce the lag in rotation -- [x] Max: Add name support for the player -- [x] Max: Setup Snake Movement on the screen -- [x] Max: Decide how to build the snake. Tons of entities? Or one entity with a list of positions? -- [x] Max: Setup basic menuing -- [x] Caden: Camera movement -- [x] Satchel: Mouse Input Support -- [x] Caden: Map generation -- [x] Satchel: How to Play View -- [x] Satchel: Create Name View -- [x] Satchel: Create Connection View -- [x] Satchel: Port Particle System -- [x] Caden: Fixed camera/renderer for more accurate collisions -- [x] Caden: Added basic HUD for kills and score -- [x] Satchel: Sound effects on the death of worm and when food is eaten -- [x] Caden: Bezier zoom interpolation on new game and death +## How to Setup +1. Install [MonoGame](https://docs.monogame.net/articles/getting_started/index.html) on your local machine. +2. Open [this](./src/DuneSnake.sln) file in Visual Studio, Jet Brains Ryder, or another compatible IDE. +3. Start the server +4. Start the client +5. Start playin! ## Debugging