Started working

README.md

@@ -1,3 +1,11 @@
 # ll-hax-docs
 
-Documentation for all love live game hacking.
+Documentation for all love live related game hacking.
+
+# Mkdocs Environment:
+```python
+conda create --name ll-hax-docs python=3.8.2
+conda activate ll-hax-docs
+pip install mkdocs mkdocs-material 
+```
+

docs/about.md

@@ -0,0 +1,16 @@
+# About
+LL Hax is a community created by Caret. The sole purpose of creating this community was to take notes and do research on hacking the SIFAC game. Then when SIF was getting EoS, Caret made sure that the community could be used for working on that, which followed SIFAS.
+
+Currently, the LL Hax community resides in a cozy discord server, but Caret also set up a matrix server as a back up, just in case (desipte unlikely-ness).
+
+### Discord Server
+[https://discord.gg/VnhnvdW8CG](https://discord.gg/VnhnvdW8CG)
+
+### Matrix Server
+Matrix is a decentralized messaging system that enables secure communication and collaboration across platforms. 
+
+[https://matrix.to/#/#ll-hax:m.sif.moe](https://matrix.to/#/#ll-hax:m.sif.moe)
+
+Check out a list of clients here:
+[https://matrix.org/ecosystem/clients/](https://matrix.org/ecosystem/clients/)
+

docs/index.md

@@ -0,0 +1,30 @@
+# Welcome
+This mkdocs instance includes all documentation related to the terms of Love Live game hacking. I'd like to keep all the important information in one place for easy access and easy contribution for other languages. 
+
+This repo for the documentation here is open source, so please make your edits there:
+
+`git clone git@codeberg.org:carette/ll-hax-docs.git`
+
+[https://codeberg.org/carette/ll-hax-docs](https://codeberg.org/carette/ll-hax-docs)
+
+DM me on [Discord](https://discord.gg/VnhnvdW8CG) if you need it to be updated (the public instance).
+
+
+# Notable Users
+Below is a list of notable users who have made contributions ranging from a few helpful messages to entire archival projects of games. This list is not in any particular order. If you would like your name removed, added or updated in anyway (as I've likely forgotten or made a mistake), please make a pull request.
+
+- CursedBlackCat
+- tungnotpunk
+- hentaku
+- AuahDark
+- rayfirefist
+- varnotfound
+- asesidaa
+- BocuD
+- gam
+- chikachi0801
+- CPPO
+- Formula91
+- Shiz
+- cosplayerkyo
+- merkusberkus

docs/pugu/README.md

@@ -0,0 +1,36 @@
+# Puchiguru
+
+Puchiguru Love Live! (ぷちぐるラブライブ！ Puchiguru Rabu raibu!) was a game released for iOS and Android, based on the Love Live! franchise. It was developed and published by Pokelabo, Inc. and was released on April 24, 2018 for both iOS and Android devices. The game's service was terminated on May 31, 2019.[^1]
+
+Puchiguru (as of 2023) has a private server hosted by `CursedBlackCat`.
+
+# Discord
+[https://discord.gg/S64Yryk](https://discord.gg/S64Yryk)
+
+(Copied from the Discord)
+>Private server APK:
+>https://pokenesos.com/
+>
+>IOS Method:
+>
+>https://pokenesos.com/ios
+
+>
+
+(Copied from [Reddit](https://www.reddit.com/r/Puchiguru/comments/8ec5le/puchiguru_download_links_for_android_and_ios/) by `CursedBlackCat`)
+>Puchiguru download links for Android and iOS!
+>[iOS Link](https://itunes.apple.com/jp/app/%E3%81%B7%E3%81%A1%E3%81%90%E3%82%8B%E3%83%A9%E3%83%96%E3%83%A9%E3%82%A4%E3%83%96/id1273636724?l=en&mt=8)
+>
+>iOS App Store Download Link
+>[Android Links](https://play.google.com/store/apps/details?id=jp.co.pokelabo.puchiguru)
+>
+>[Android Google Play Download Link](https://play.google.com/store/apps/details?id=jp.co.pokelabo.puchiguru)
+>
+>[Android APK Download Link (APKpure)](https://apkpure.com/%E3%81%B7%E3%81%A1%E3%81%90%E3%82%8B%E3%83%A9%E3%83%96%E3%83%A9%E3%82%A4%E3%83%96%EF%BC%81/jp.co.pokelabo.puchiguru)
+>
+>[Android QooApp Link](https://apps.qoo-app.com/en/app/5627/%E3%81%B7%E3%81%A1%E3%81%90%E3%82%8B%E3%83%A9%E3%83%96%E3%83%A9%E3%82%A4%E3%83%96%EF%BC%81)
+>
+>Please note that you will not be able to play the game until the server goes live at 12PM noon on April 24, JST. A countdown timer until then can be found [here](https://www.timeanddate.com/countdown/generic?iso=20180424T12&p0=248&msg=Puchiguru+Server+Goes+Live&font=cursive&csz=1).
+>
+
+[^1]: https://love-live.fandom.com/wiki/Puchiguru_Love_Live!

docs/sif/README.md

@@ -0,0 +1,17 @@
+# SIF
+(the following was copied from the fandom wiki)
+Love Live! School idol festival (ラブライブ！スクールアイドルフェスティバル Rabu raibu! Sukūru Aidoru Fesutibaru, LLSIF) was a rhythm game released for iOS and Android, based on the Love Live! franchise. It was published by Bushiroad and developed by KLab Inc. and was released on April 16, 2013 for iOS and June 6, 2013 for Android devices.
+
+An English version was released on May 12, 2014 under the title "School Idol Festival" at version 1.6. A Taiwanese version was released on May 22, 2014 under Mobimon Inc. at version 1.2. A Chinese version was released on June 12, 2014 under MariyGames at version 1.0. A Korean version was released on July 1, 2014 under NHN Entertainment Corp. at version 1.1. The Korean version was shut down and merged with the Global version on August 10, 2016. The Traditional Chinese version was shut down and merged with the Global version as of May 17, 2017. The Japanese Version was merged with the Global Version on June 10, 2021 and the Korean version & Traditional Chinese options was removed.
+
+An arcade version was announced to be in production on November 27, 2015 and was made available for play on December 6, 2016. A new game titled Love Live! School Idol Festival ALL STARS was announced to be in production on September 21, 2017, and was released on September 26, 2019. Both games will continue to run concurrently alongside each other.
+
+A successor to the game Love Live! School idol festival 2 MIRACLE LIVE! was announced on September 25, 2022, also featuring Nijigasaki High School Idol Club and Liella!.
+
+On January 31, 2023, it was announced that the game's service would be shut down on March 31, 2023. [^1]
+
+# Private Servers
+
+# Self Hostable Servers
+
+[^1]: https://love-live.fandom.com/wiki/Love_Live!_School_idol_festival

docs/sifas/README.md

@@ -0,0 +1 @@
+# SIFAS

mkdocs.yml

@@ -0,0 +1,34 @@
+site_name: LL Hax Docs
+site_url: https://ll.hax.sif.moe
+nav:
+  - Home: index.md
+  - Puchiguru: pugu/README.md
+  - SIF: sif/README.md
+  - SIFAC: sifac/README.md
+  - SIFAS: sifas/README.md
+  - About: about.md
+theme:
+  name: material
+  language: en
+  palette: 
+    # Palette toggle for light mode
+    - scheme: default
+      toggle:
+        icon: material/brightness-7 
+        name: Switch to dark mode
+    # Palette toggle for dark mode
+    - scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+extra:
+  alternate:
+    - name: English
+      link: /en/ 
+      lang: en
+    - name: 日本語
+      link: /ja/
+      lang: ja
+    - name: 中国人
+      link: /zh_CN/
+      lang: zh_CN

run.sh

@@ -0,0 +1,3 @@
+conda create --name ll-hax-docs python=3.8.2
+conda activate ll-hax-docs
+pip install mkdocs-material