README.md 3.5 KB

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: FlipperHTTP GitHub
  • 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 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

  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

  • 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