1
Fork 0
mirror of https://github.com/Steffo99/pineapple-surf.git synced 2024-11-21 15:34:17 +00:00

Add readme

This commit is contained in:
Steffo 2023-01-09 23:31:15 +01:00
parent d2b1f91a3b
commit 3a8d829da5
Signed by: steffo
GPG key ID: 6965406171929D01

73
README.md Normal file
View file

@ -0,0 +1,73 @@
# ![Pineapple Surf](media/itch-banner.png)
_Bunnyhopping, retro-looking, first person seed shooter_
## Ludum Dare 51: Compo entry
[![Overall: TBD](https://img.shields.io/badge/overall-TBD-lightgrey)
![Fun: TBD](https://img.shields.io/badge/fun-TBD-lightgrey)
![Innovation: TBD](https://img.shields.io/badge/innovation-TBD-lightgrey)
![Theme: TBD](https://img.shields.io/badge/theme-TBD-lightgrey)
![Graphics: TBD](https://img.shields.io/badge/graphics-TBD-lightgrey)
![Humor: TBD](https://img.shields.io/badge/humor-TBD-lightgrey)
![Mood: TBD](https://img.shields.io/badge/mood-TBD-lightgrey)](https://ldjam.com/events/ludum-dare/52/pineapple-surf)
## About
![The Pineapple God: a pineapple with sunglasses.](assets/pineglasses.png "The Pineapple God: a pineapple with sunglasses.")
A Pineapple God has teleported you to a tropical archipelago, and demands that you surround it with followers!
1. Collect seeds around the archipelago
2. Use your peashooter to plant them on horizontal surfaces
3. Walk nearby grown pineapples to harvest them
4. Bring them to the Pineapple God until it is satisfied
## Controls
- <kbd>W</kbd> <kbd>A</kbd> <kbd>S</kbd> <kbd>D</kbd> → Move
- <kbd>Mouse movement</kbd> → Look
- <kbd>Mouse primary click</kbd> → Shoot
- <kbd>Space</kbd> → Jump
- <kbd>Space</kbd> (held) → **Bunnyhop!**
- <kbd>Shift + R</kbd> → Respawn if stuck
- <kbd>Esc</kbd> → Return to the main menu
## Leaderboards
The Pineapple god will keep track of the time it takes you to bring it 150 pineapples, and will compare it with that of his other servants. **Can you be the fastest?**
_The leaderboards are experimental, unmoderated, and have no anti-cheat. Please be nice!_
## How to go faster
Pineapple Surf is centered on the mechanic of bunnyhopping to move faster!
The mechanics are similar to those of [the first Half-Life](https://www.youtube.com/watch?v=WschEm9uYao): a simple way to start going faster is holding <kbd>Space</kbd> and <kbd>D</kbd> while constantly turning right in a circle.
## Screenshots
![The menu of the game, Pineapple Surf.](media/screenshot-menu.png "The menu of the game, Pineapple Surf.")
![The archipelago of the Pineapple God, from the first person view of the player. A grown pineapple is at the center of the screen.](media/screenshot-archipelago.png "The archipelago of the Pineapple God, from the first person view of the player. A grown pineapple is at the center of the screen.")
![Ten pineapple sprouts have been planted and are growing.](media/screenshot-growing.png "Ten pineapple sprouts have been planted and are growing.")
![The temple of the Pineapple God, with a white holy beam at the top.](media/screenshot-pineapplegod.png "The temple of the Pineapple God, with a white holy beam at the top.")
## Credits
See [the EXTERNAL_LICENSES.md file](https://github.com/Steffo99/pineapple-surf/blob/main/EXTERNAL_LICENSES.md) for a list of all external assets used.