From 82f9b409fd94295661f243b444130e5deb7fbe00 Mon Sep 17 00:00:00 2001
From: AderKI <66168124+AderKonstantin@users.noreply.github.com>
Date: Sat, 2 Nov 2024 03:01:40 +0300
Subject: [PATCH] Create README.md

---
 README.md | 136 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 136 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..41ecf53
--- /dev/null
+++ b/README.md
@@ -0,0 +1,136 @@
+# Multiplayer Game Project "Robot Fire"
+Work Title: Robot Fire
+Age: 16+
+Preview Date: 11/12/2024
+Release Date: - 
+
+
+## Todo
+- Distance Fog for Camera
+- Server-Client Rpc Synchronization
+- In-game debug console.
+- Custom kinematic character controller (for base Character Movement).
+  - Momentum-based movement
+  - Snappy movement
+  - Collision Detection
+- In-game runtime editor.
+
+
+
+## Classes
+- Class PlayerEssence
+  - ConnectingToFreeRobot
+  - StateMachine
+  - InputForPlayerEssense
+  - PlayerEssenceForEachPlayer(hasAuthority)
+
+
+- Class RobotBase
+  - Movement
+  - Jump
+  - InputForRobot
+  - OwnershipToPlayer
+  - BaseWeapon
+  - BaseAdvancementsParts (Wearable rocket carriers, Radio jamming device or something like that (i.e. worn on a robot as a RobotComponent))
+
+
+## Game Mechanics
+
+### Player Controller
+
+Players have two states: without a robot, controlling the robot.
+
+Interface: 
+
+## Resources 
+- `gun_bullets`
+- `projectiles` for such weapons
+- `spare_parts` (Robot Components)
+- `armor_plates` (Robot Components)
+- `in-game_resources`:
+  - `gold` (for motherboards_of_robots),
+  - `silver` (for electronics),
+  - `platinum` (for radioelectronics),
+  - `iron` (for spare_parts or armor_plates).
+
+## Robots (Classes / Their Tasks)
+
+Standard Class (Robot (Non-Playing Class / Parent Class) ):
+
+- Robots can move.
+- Robots have different movement speeds.
+- Robots have inventory slots (weapons, mods, cargo).
+- Robots can carry loads with them: small boxes and boxes on themselves, trolleys on a trailer.
+- Robots have several states: hibernation (there is no player), loading, active, inactive (with player), disabled (is dead).
+- Robots can be repaired (using spare parts).
+- The player can switch between free robots connected to the docking station.
+- Robots can be rebuilt on the docking station, without the cost of spare parts.
+- Each robot has a role that defines its characteristics.
+
+From the roles of robots: Trooper, Builder, Engineer, Medic.
+
+- Trooper - can carry assault rifles and more armor. Capturing points and thus providing the team with various resources. Purpose: attack and capture new territories.
+- Builder - can use a special weapon in one slot, can drag large loads (up to 5 trolleys) over long distances. Purpose: logistics and strengthening of territories.
+- Engineer - can only carry special weapons. Creates weapons, ammo, spare_parts, AdvancementsParts for robots. Goal: Improve the army of robots.
+- Medic - can carry other robots. Repair all kinds of robots, create new ones at the docking station. Purpose: organization of the work of robots.
+
+Three branches of development:
+
+- Mechanics (mechanical parts) - weapons, logistics, armor. 
+- Electronics (electronic parts) - interface, robot repair, robot creation. 
+- Radio engineering (radio hacking) - turning off the robot, capturing the robot, radio interference.
+
+## Weapon Types:
+
+### Handguns
+
+- Revolver
+- Pistol
+
+### Rifles
+
+#### Assault(Automatic)
+- AK-74M
+- M4 Carbine
+
+#### Bolt-Action
+- Remington Model 700
+
+#### Semi-Automatic
+- SVD (rifle)
+
+#### Shotguns
+- AA-12
+
+#### SMG
+- UZI
+- Vector  
+- MP5K 
+- MAC10
+
+#### LMG
+- M249
+
+### Light Weapons
+- HMG
+- RPG
+- ATGM
+- MPADS
+
+### Artillery Missiles
+
+#### ABM (Anti-Ballistic Missile)
+
+#### SSM (Surface-to-surface, ballistic missile)
+
+### Artillery Missiles Launchers
+
+#### Wheeled Missile Launcher like HIMARS
+
+#### Multiple Landed Missile Launcher
+
+#### Single Landed Missile Launcher
+
+## Docking Station
+
+The Docking Station is a base for each teams. Reproduce new robots each two minutes. In order to win, the enemy must destroy this Docking Station. The Docking Station can be repaired by medics/engineers.