فهرست منبع

updated readme and changelog

jblanked 1 سال پیش
والد
کامیت
a2aca3ef71
3فایلهای تغییر یافته به همراه130 افزوده شده و 17 حذف شده
  1. 56 7
      README.md
  2. 20 2
      assets/CHANGELOG.md
  3. 54 8
      assets/README.md

+ 56 - 7
README.md

@@ -3,38 +3,87 @@
 The first open-world multiplayer game for the Flipper Zero, best played with the VGM.
 
 ## Requirements
-- WiFi Developer Board, Raspberry Pi, or ESP32 device with the FlipperHTTP flash: https://github.com/jblanked/FlipperHTTP
+
+- WiFi Developer Board, Raspberry Pi, or ESP32 device with the FlipperHTTP flash: [FlipperHTTP GitHub](https://github.com/jblanked/FlipperHTTP)
 - 2.4 GHz WiFi access point
 
 ## How It Works
-FlipWorld and FlipSocial are connected. Your login information is the same in both apps; if you register an account in either app, you can log in to both using that information. This also means that your friends, messages, and achievements are synced between apps. You only need a username and password to start, which is set in the User Settings. Keep in mind your username will be displayed to others, so choose wisely.
 
-We've simplified the settings for easy use of the app. In the Game Settings, you can adjust the FPS (30, 60, 120, or 240), download World Packs, and select whether you want the screen backlight to always be on.
+FlipWorld and FlipSocial are connected. Your login information is the same in both apps; if you register an account in either app, you can log in to both using that information. This also means that your friends, messages, and achievements are synced between apps. You only need a username and password to start, which are set in the User Settings. Keep in mind your username will be displayed to others, so choose wisely.
+
+**Settings**
+
+- **WiFi**: Enter your SSID and password to connect to your 2.4 GHz network.
+- **User**: Add or update your username and password (this is the same login information as your FlipSocial account).
+- **Game**: Install the Official World Pack, set your FPS (30, 60, 120, or 240), and select whether you want the screen backlight to always be on, the sound to be on, and the vibration to be on.
+
+**Controls**
+
+- **Press/Hold LEFT**: Turn left if not already facing left, then walk left if the button is still pressed.
+- **Press/Hold RIGHT**: Turn right if not already facing right, then walk right if the button is still pressed.
+- **Press/Hold UP**: Walk up.
+- **Press/Hold DOWN**: Walk down.
+- **Press/Hold UP**: Attack/Teleport (set to attack until all enemies are defeated).
+
+**Player Attributes**
+
+- **Health**: The amount of life points the player has.
+- **XP**: The amount of experience points the player has.
+- **Level**: The rank/level of the player.
+- **Strength**: The attack power of the player's attacks.
+- **Health Regeneration**: The amount of health a player gains per second.
+- **Attack Timer**: The duration the player must wait between attacks.
+
+As a new player, you have 100 health, 0 XP, 10 strength, 1 health regeneration, an attack timer of 1, and are level 1. Each level, the player gains an extra 1 strength and 10 health. Additionally, the amount of XP needed to level up increases exponentially by 1.5. For example, to reach level 2, you need 100 XP; for level 3, 150 XP; for level 4, 225 XP; and so on.
+
+**Enemies**
+
+Enemies have similar attributes to players but do not have XP or health regeneration. For example, level 1 enemies have 100 health and 10 strength, just like a level 1 player.
+
+**Attacks**
+
+If an enemy attacks you, your health decreases by the enemy's strength (attack power). Additionally, if an enemy defeats you, your XP decreases by the amount of the enemy's strength. Conversely, when you successfully attack an enemy, you gain 10% of the enemy's strength as health and increase your XP by the enemy's full strength.
+
+## Short Tutorial
 
-The controls in the game are straightforward. Press and hold left to go left, press and hold right to go right, etc. If you press the OK button, it will teleport you to the next available world. **Do NOT spam the OK button** as it could freeze your Flipper Zero. Press it once and wait for it to load.
+1. Ensure your WiFi Developer Board and Video Game Module are flashed with FlipperHTTP.
+2. Install the app.
+3. Restart your Flipper Zero, then open FlipWorld.
+4. Click `Settings -> WiFi`, then input your WiFi SSID and password.
+5. Hit the `BACK` button, click `User`. If your username is not present, click `Username` and add one. Do the same for the password field.
+6. Go back to the main menu and hit `Play`. It will register an account if necessary and fetch data from our API that's used to render our graphics.
 
 ## Roadmap
+
 **v0.2**
-- Stability patch
+
+- Game Mechanics
 - Video Game Module support
 
 **v0.3**
-- ???
+
+- Stability patch
 
 **v0.4**
+
 - ???
 
 **v0.5**
+
 - ???
 
 **v0.6**
+
 - ???
 
 **v0.7**
+
 - ???
 
 **v0.8**
+
 - Multiplayer support
 
 **v1.0**
-- Official release
+
+- Official release

+ 20 - 2
assets/CHANGELOG.md

@@ -1,2 +1,20 @@
-## 0.1
-- Initial Release
+## [0.2] - 2025-01-02
+### Added
+- **Video Game Module Support:** Added support for the Video Game Module (requires FlipperHTTP flash).
+- **Enemies:** Introduced various enemy types to enhance gameplay.
+- **Player Attributes:** Added player health, XP, level, health regeneration, attack, and strength.
+- **Notifications:** Implemented vibration, sound, and LED notifications when a player is attacking or being attacked.
+- **User Interface Enhancements:**
+  - Displayed the player's username above their character.
+  - Showed the player's health, XP, and level in the bottom left corner of the screen, visible at all times.
+
+### Changed
+- **Icons:** Updated all game icons for better visual appeal.
+- **Library Update:** Upgraded to the latest version of the FlipperHTTP library.
+- **Game Settings:** Revised toggles in the Game Settings to ensure they work as intended.
+- **Collisions:** Improved collision mechanics for more accurate interactions.
+- **Default Character Icon:** Updated the default icon representing the player's character.
+
+## [0.1] - 2024-12-21
+### Added
+- **Initial Release:** Launched the first version of the game with basic features.

+ 54 - 8
assets/README.md

@@ -1,40 +1,86 @@
-# FlipWorld
-
 The first open-world multiplayer game for the Flipper Zero, best played with the VGM.
 
 ## Requirements
+
 - WiFi Developer Board, Raspberry Pi, or ESP32 device with the FlipperHTTP flash: https://github.com/jblanked/FlipperHTTP
 - 2.4 GHz WiFi access point
 
 ## How It Works
-FlipWorld and FlipSocial are connected. Your login information is the same in both apps; if you register an account in either app, you can log in to both using that information. This also means that your friends, messages, and achievements are synced between apps. You only need a username and password to start, which is set in the User Settings. Keep in mind your username will be displayed to others, so choose wisely.
 
-We've simplified the settings for easy use of the app. In the Game Settings, you can adjust the FPS (30, 60, 120, or 240), download World Packs, and select whether you want the screen backlight to always be on.
+FlipWorld and FlipSocial are connected. Your login information is the same in both apps; if you register an account in either app, you can log in to both using that information. This also means that your friends, messages, and achievements are synced between apps. You only need a username and password to start, which are set in the User Settings. Keep in mind your username will be displayed to others, so choose wisely.
+
+**Settings**
+- **WiFi**: Enter your SSID and password to connect to your 2.4 GHz network.
+- **User**: Add or update your username and password (this is the same login information as your FlipSocial account).
+- **Game**: Install the Official World Pack, set your FPS (30, 60, 120, or 240), and select whether you want the screen backlight to always be on, the sound to be on, and the vibration to be on.
+
+**Controls**
+
+- **Press/Hold LEFT**: Turn left if not already facing left, then walk left if the button is still pressed.
+- **Press/Hold RIGHT**: Turn right if not already facing right, then walk right if the button is still pressed.
+- **Press/Hold UP**: Walk up.
+- **Press/Hold DOWN**: Walk down.
+- **Press/Hold UP**: Attack/Teleport (set to attack until all enemies are defeated).
+
+**Player Attributes**
+
+- **Health**: The amount of life points the player has.
+- **XP**: The amount of experience points the player has.
+- **Level**: The rank/level of the player.
+- **Strength**: The attack power of the player's attacks.
+- **Health Regeneration**: The amount of health a player gains per second.
+- **Attack Timer**: The duration the player must wait between attacks.
+
+As a new player, you have 100 health, 0 XP, 10 strength, 1 health regeneration, an attack timer of 1, and are level 1. Each level, the player gains an extra 1 strength and 10 health. Additionally, the amount of XP needed to level up increases exponentially by 1.5. For example, to reach level 2, you need 100 XP; for level 3, 150 XP; for level 4, 225 XP; and so on.
+
+**Enemies**
+
+Enemies have similar attributes to players but do not have XP or health regeneration. For example, level 1 enemies have 100 health and 10 strength, just like a level 1 player.
+
+**Attacks**
+
+If an enemy attacks you, your health decreases by the enemy's strength (attack power). Additionally, if an enemy defeats you, your XP decreases by the amount of the enemy's strength. Conversely, when you successfully attack an enemy, you gain 10% of the enemy's strength as health and increase your XP by the enemy's full strength.
+
+## Short Tutorial
 
-The controls in the game are straightforward. Press and hold left to go left, press and hold right to go right, etc. If you press the OK button, it will teleport you to the next available world. **Do NOT spam the OK button** as it could freeze your Flipper Zero. Press it once and wait for it to load.
+1. Ensure your WiFi Developer Board and Video Game Module are flashed with FlipperHTTP.
+2. Install the app.
+3. Restart your Flipper Zero, then open FlipWorld.
+4. Click **Settings** -> **WiFi**, then input your WiFi SSID and password.
+5. Hit the **BACK** button, click **User**. If your username is not present, click **Username** and add one. Do the same for the password field.
+6. Go back to the main menu and hit **Play**. It will register an account if necessary and fetch data from our API that's used to render our graphics.
 
 ## Roadmap
+
 **v0.2**
-- Stability patch
+
+- Game Mechanics
 - Video Game Module support
 
 **v0.3**
-- ???
+
+- Stability patch
 
 **v0.4**
+
 - ???
 
 **v0.5**
+
 - ???
 
 **v0.6**
+
 - ???
 
 **v0.7**
+
 - ???
 
 **v0.8**
+
 - Multiplayer support
 
 **v1.0**
-- Official release
+
+- Official release