git » crow.game » commit aeb2ecd

crow.game.site: add site, misc

author b0in
2023-11-22 22:02:13 UTC
committer b0in
2023-11-22 22:02:13 UTC
parent b1fb0c7e4bf8eee360616daff354735f2e647c44

crow.game.site: add site, misc

 * add site workflow in parent pom.
 * fix developer tag in pom.
 * update pom format configs.

crow.game.site/pom.xml +12 -0
crow.game.site/src/site/apt/faq.apt +29 -0
crow.game.site/src/site/apt/index.apt +12 -0
crow.game.site/src/site/resources/css/site.css +71 -0
crow.game.site/src/site/site.xml +21 -0
pom.xml +64 -15

diff --git a/crow.game.site/pom.xml b/crow.game.site/pom.xml
new file mode 100644
index 0000000..b2189cb
--- /dev/null
+++ b/crow.game.site/pom.xml
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <parent>
+    <groupId>crow.game</groupId>
+    <artifactId>crow.game.root</artifactId>
+    <version>0.1-SNAPSHOT</version>
+  </parent>
+  <artifactId>crow.game.site</artifactId>
+  <packaging>pom</packaging>
+</project>
diff --git a/crow.game.site/src/site/apt/faq.apt b/crow.game.site/src/site/apt/faq.apt
new file mode 100644
index 0000000..6592f68
--- /dev/null
+++ b/crow.game.site/src/site/apt/faq.apt
@@ -0,0 +1,29 @@
+FAQ
+
+* Why build a kRO server from scratch?
+
+    This mixes a handful of hobby horses I've wanted to get into:
+    Netty, modular Java servers, and game servers.
+
+* What does the name mean?
+
+    Oh you know, crow aka kRO. It's very clever. crow is the umbrella project and crow.game
+    is the kRO server emulator.
+
+* Will it be compatible with rathena or herculus?
+
+    I'm currently working alongside rathena, implementing it's HA packets so that I can
+    test the full workflow of a given component alongside existing rathena components.
+
+    However: it is not guaranteed to have ongoing drop-in with either one. Meaning,
+    you may not be able to migrate directly from any existing server to Crow.
+
+* How much is done?
+
+    Gosh probably 1%. Currently the login server works alongside rathena char and map servers. If
+    you have an rathena mysql DB setup with a user, you can run the login server, point the
+    char server to it, and the full workflow will work, though it will be buggy.
+
+* Which kRO protocol versions are supported?
+
+    TODO
diff --git a/crow.game.site/src/site/apt/index.apt b/crow.game.site/src/site/apt/index.apt
new file mode 100644
index 0000000..4eff39d
--- /dev/null
+++ b/crow.game.site/src/site/apt/index.apt
@@ -0,0 +1,12 @@
+About
+
+    crow.game. It's a game server / game server emulator.
+
+* Downloading the crow.game source code
+
+    You can download the source code here: {{https://b0in.xyz/crow/crow-game-latest.tar.gz}}.
+
+* Binary releases:
+
+    There is an OMNIBUS release which contains all the existing work so far as a runnable-jar
+    here: {{https://b0in.xyz/crow/releases/crow-game-omnibus-2023NNNN.tar.gz}}.
\ No newline at end of file
diff --git a/crow.game.site/src/site/resources/css/site.css b/crow.game.site/src/site/resources/css/site.css
new file mode 100644
index 0000000..959a4f8
--- /dev/null
+++ b/crow.game.site/src/site/resources/css/site.css
@@ -0,0 +1,71 @@
+body {
+  width: 900px;
+  margin: 0px auto;
+  margin-top: 20px;
+  border: 1px solid grey;
+  padding: 20px;
+  box-shadow: black 4px 4px 2px;
+  background-color: white;
+}
+
+
+@media only screen and (max-width: 600px) {
+  body {
+      max-width: 90%;
+      padding: 10px;
+      box-shadow: none;
+      margin-top: 5px;
+      margin-bottom: 5px;
+  }
+  #leftColumn {
+    width: 80%;
+    float: none;
+    overflow: none;
+    margin: 0 auto;
+    margin-top: 20px;
+  }
+
+  #bodyColumn {
+    margin-right: 30px;
+    margin-left:30px;
+  }
+
+  #breadcrumbs {
+    width: 80%;
+    margin: 0 auto;
+  }
+
+  #bannerLeft, #banner {
+    font-size: medium;
+    font-weight: bold;
+    margin: 0px auto;
+    width: 80%;
+  }
+}
+
+html {
+  background-color: #cfcfff;
+}
+
+h2, h3, h1 {
+  border: none;
+  background-color: transparent;
+  padding: 2px;
+  text-decoration: underline;
+}
+
+.poweredBy {
+  display: none;
+}
+
+#navcolumn li.none {
+  padding: 5px;
+}
+
+#navcolumn li.expanded {
+  padding-top: 5px;
+}
+
+#navcolumn li.collapsed {
+  padding-top: 5px;
+}
\ No newline at end of file
diff --git a/crow.game.site/src/site/site.xml b/crow.game.site/src/site/site.xml
new file mode 100644
index 0000000..b245894
--- /dev/null
+++ b/crow.game.site/src/site/site.xml
@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project name="Crow Game Server Emulator"
+         xmlns="http://maven.apache.org/SITE/2.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0 https://maven.apache.org/xsd/site-2.0.0.xsd">
+
+    <version position="none"/>
+    <bannerLeft>
+        <name>Crow Game Server (crow.game)</name>
+    </bannerLeft>
+    <publishDate position="right"/>
+
+    <body>
+        <footer><!-- x --></footer>
+        <menu name="Overview">
+            <item name="About" href="index.html" />
+            <item name="FAQ" href="faq.html" />
+        </menu>
+        <menu ref="reports"/>
+    </body>
+</project>
\ No newline at end of file
diff --git a/pom.xml b/pom.xml
index 944c0e4..d1befd0 100644
--- a/pom.xml
+++ b/pom.xml
@@ -1,42 +1,43 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
-
   <groupId>crow.game</groupId>
   <artifactId>crow.game.root</artifactId>
   <version>0.1-SNAPSHOT</version>
   <packaging>pom</packaging>
   <inceptionYear>2023</inceptionYear>
-
   <organization>
     <name>crow.game</name>
     <url>https://b0in.xyz/crow</url>
   </organization>
-
   <licenses>
     <license>
       <name>GNU General Public License (GPL) version 3.0</name>
       <url>https://www.gnu.org/licenses/gpl-3.0.txt</url>
     </license>
   </licenses>
-
-  <contributors>
-    <contributor>
+  <developers>
+    <developer>
       <name>b0in</name>
       <email>b0in@proton.me</email>
       <url>https://b0in.xyz</url>
       <roles>
         <role>creator</role>
       </roles>
-    </contributor>
-  </contributors>
-
+    </developer>
+  </developers>
+  <modules>
+    <module>crow.game.site</module>
+  </modules>
+  <scm>
+    <connection>scm:git:https://b0in.xyz/crow/crow-latest-git.tar.gz</connection>
+  </scm>
   <properties>
     <maven.compiler.source>17</maven.compiler.source>
     <maven.compiler.target>17</maven.compiler.target>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
   </properties>
-
   <build>
     <plugins>
       <plugin>
@@ -49,9 +50,10 @@
               <include>pom.xml</include>
               <include>**/pom.xml</include>
             </includes>
-
             <sortPom>
-              <!-- x-->
+              <keepBlankLines>false</keepBlankLines>
+              <indentSchemaLocation>true</indentSchemaLocation>
+              <sortPlugins>groupId,artifactId</sortPlugins>
             </sortPom>
           </pom>
           <formats>
@@ -59,7 +61,6 @@
               <includes>
                 <include>src/*/java/**/*.java</include>
               </includes>
-
               <prettier>
                 <devDependencies>
                   <prettier>2.0.5</prettier>
@@ -82,7 +83,55 @@
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-site-plugin</artifactId>
+        <version>3.12.1</version>
+        <configuration>
+          <siteDirectory>${project.basedir}/crow.game.site/src/site</siteDirectory>
+        </configuration>
+      </plugin>
     </plugins>
   </build>
-
+  <reporting>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-changelog-plugin</artifactId>
+        <version>2.3</version>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>3.5.0</version>
+        <reportSets>
+          <reportSet>
+            <id>aggregate</id>
+            <reports>
+              <report>aggregate</report>
+            </reports>
+            <inherited>false</inherited>
+          </reportSet>
+          <reportSet>
+            <id>default</id>
+            <reports>
+              <report>javadoc</report>
+            </reports>
+          </reportSet>
+        </reportSets>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-project-info-reports-plugin</artifactId>
+        <version>3.4.5</version>
+        <reportSets>
+          <reportSet>
+            <reports>
+              <report>licenses</report>
+            </reports>
+          </reportSet>
+        </reportSets>
+      </plugin>
+    </plugins>
+  </reporting>
 </project>