Merge game basics to Main

README.md

@@ -0,0 +1,127 @@
+# Pegasus Framework
+
+## Getting started
+
+### Creating instance class
+
+Start by creating an instance class **with this constructor**, and implementing all lifecycle methods.
+
+All the instance logic goes on this class !
+
+```java
+public class SampleInstance extends Instance {
+    public SampleInstance(int id, JavaPlugin plugin, CommonOptions commonOptions, InstanceOptions instanceOptions, ScoreManager scoreManager) {
+        super(id, plugin, commonOptions, instanceOptions, scoreManager);
+    }
+}
+```
+
+### Setting up instance behavior
+
+#### Main plugin class
+
+Make sure that your plugin extends of PegasusPlugin.
+
+```java
+public class GameSamplePlugin extends PegasusPlugin{
+    @Override
+    public void onEnable(){
+        super.onEnable();
+        // The initialization code goes here
+    }
+}
+```
+#### Creating the game world
+
+To create the game world, just create a new WorldBuilder, and set on it all the world options that you want !
+
+After that, just call the ServerManager#addGameWorld(WorldBuilder) to get the newly created game world.
+
+_Note : If the game world already exists, the given settings will overwrite the older._
+
+```java
+public class GameSamplePlugin extends PegasusPlugin{
+    @Override
+    public void onEnable(){
+        super.onEnable();
+        WorldBuilder gameWorldBuilder = new WorldBuilder("pegasus_sample");
+        gameWorldBuilder.setGameMode(GameMode.CREATIVE)
+                .setDifficulty(Difficulty.PEACEFUL)
+                .addGameRule(GameRule.DO_DAYLIGHT_CYCLE, false)
+                .addGameRule(GameRule.DO_WEATHER_CYCLE, false)
+                .setWorldTime(6000)
+                .addPrevention(WorldPreventions.ALL)
+                .addPrevention(WorldPreventions.PREVENT_PVP);
+        PegasusWorld gameWorld = this.getServerManager().addGameWorld(gameWorldBuilder);
+    }
+}
+```
+
+#### Creating the game settings
+
+Start by creating a new OptionsBuilder, and set all the settings you want.
+
+_Note : Some settings are mandatory to the game be runnable!_
+
+After that, you can get the GameManager by calling the ServerManager#createGameManager(DataManager, OptionsBuilder, ScoreManager) method.
+
+```java
+public class GameSamplePlugin extends PegasusPlugin{
+    @Override
+    public void onEnable(){
+        super.onEnable();
+        // Game world creation code...
+        OptionsBuilder optionsBuilder = new OptionsBuilder()
+                .setGameType(GameType.SOLO)
+                .setWorld(gameWorld)
+                .setInstanceClass(SampleInstance.class)
+                .setRoundDurations(List.of(20))
+                .setSpawnPoints(List.of(new RelativeLocation(0.5, 0, 0.5, 90, 0)))
+                .setSchematic(new Schematic(this, "instances_test", SchematicFlags.COPY_BIOMES))
+                .setPreAllocatedInstances(1);
+        gameManager = this.getServerManager().createGameManager(new SampleDataManager(), optionsBuilder, new SampleScoreManager());
+    }
+}
+```
+
+#### Starting the game
+
+To start the game, just call the GameManager#start() method.
+
+## Lifecycles
+
+### Instance lifecycle and behavior
+
+| Instance state    | Player game mode | Is player frozen |
+|-------------------|------------------|------------------|
+| CREATED           | Not on instance  | Not on instance  |
+| READY             | SPECTATOR        | NO               |
+| PRE_STARTED       | SPECTATOR        | NO               |
+| STARTED           | SPECTATOR        | NO               |
+| ROUND_PRE_STARTED | ADVENTURE        | YES              |
+| ROUND_STARTED     | SURVIVAL         | NO               |
+| ROUND_ENDED       | SPECTATOR        | NO               |
+| ENDED             | SPECTATOR        | NO               |
+| CLOSED            | Not on instance  | Not on instance  |
+
+### Instances Manager lifecycle
+
+| Instance Manager state | Changed when all instances are in state |
+|------------------------|-----------------------------------------|
+| READY                  | READY                                   |
+| STARTED                | STARTED                                 |
+| ENDED                  | CLOSED                                  |
+
+### Game Manager lifecycle
+
+| Game Manager state | Changed when...                                          |
+|--------------------|----------------------------------------------------------|
+| CREATED            | when new instance created                                |
+| STARTED            | when start method is called                              |
+| ENDED              | when stop method is called or Instances Manager is ENDED |
+
+## How to get which data ?
+
+### Instance
+- Teams and players : Instance#getPlayerManager()
+- Score : Instance#getScoreManager()

pegasus-framework.iml

@@ -5,4 +5,15 @@
       <excludeFolder url="file://$MODULE_DIR$/.idea/copilot/chatSessions" />
     </content>
   </component>
+  <component name="FacetManager">
+    <facet type="minecraft" name="Minecraft">
+      <configuration>
+        <autoDetectTypes>
+          <platformType>PAPER</platformType>
+          <platformType>ADVENTURE</platformType>
+        </autoDetectTypes>
+        <projectReimportVersion>1</projectReimportVersion>
+      </configuration>
+    </facet>
+  </component>
 </module>

pom.xml

@@ -19,6 +19,10 @@
             <id>papermc</id>
             <url>https://repo.papermc.io/repository/maven-public/</url>
         </repository>
+        <repository>
+            <id>enginehub-maven</id>
+            <url>https://maven.enginehub.org/repo/</url>
+        </repository>
     </repositories>
 
     <dependencies>
@@ -28,6 +32,24 @@
             <version>1.20.4-R0.1-SNAPSHOT</version>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>com.sk89q.worldedit</groupId>
+            <artifactId>worldedit-core</artifactId>
+            <version>7.2.14</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.sk89q.worldedit</groupId>
+            <artifactId>worldedit-bukkit</artifactId>
+            <version>7.2.14</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <version>5.8.1</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>

src/main/java/fr/pegasus/papermc/PegasusPlugin.java

@@ -0,0 +1,37 @@
+package fr.pegasus.papermc;
+
+import fr.pegasus.papermc.managers.ServerManager;
+import org.bukkit.plugin.java.JavaPlugin;
+
+import java.util.logging.Logger;
+
+@SuppressWarnings("unused")
+public class PegasusPlugin extends JavaPlugin {
+
+    public static Logger logger = Logger.getLogger("PegasusFramework");
+    private ServerManager serverManager;
+
+    @Override
+    public void onLoad() {
+        super.onLoad();
+        logger.info("Pegasus Framework has been loaded");
+    }
+
+    @Override
+    public void onEnable() {
+        super.onEnable();
+        serverManager = new ServerManager(this);
+        serverManager.initLobby();
+        logger.info("Pegasus Framework has been enabled");
+    }
+
+    @Override
+    public void onDisable() {
+        super.onDisable();
+        logger.info("Pegasus Framework has been disabled");
+    }
+
+    public ServerManager getServerManager() {
+        return serverManager;
+    }
+}