dox but fr this time

Vortex2Oblivion · Feb 8, 2024 · d79b11c · d79b11c
1 parent f85fd48
commit d79b11c
Show file tree

Hide file tree

Showing 20 changed files with 75 additions and 797 deletions.
diff --git a/.github/workflows/workflow.yml b/.github/workflows/workflow.yml
@@ -46,6 +46,7 @@ jobs:
           haxelib git scriptless-polymod https://github.com/swordcube/scriptless-polymod
           haxelib install hxvlc
           haxelib git discord_rpc https://github.com/Aidan63/linc_discord-rpc
+          haxelib install dox
           haxelib git flixelTextureAtlas https://github.com/Smokey555/Flixel-TextureAtlas.git
           haxelib git fnf-modcharting-tools https://github.com/EdwhakKB/FNF-Modcharting-Tools
           haxelib git flxanimate https://github.com/Dot-Stuff/flxanimate
@@ -97,6 +98,7 @@ jobs:
           haxelib git hscript-improved https://github.com/FNF-CNE-Devs/hscript-improved
           haxelib git openfl https://github.com/openfl/openfl
           haxelib git HxWebView https://github.com/Vortex2Oblivion/HxWebView
+          haxelib install dox
           haxelib git flixelTextureAtlas https://github.com/Smokey555/Flixel-TextureAtlas.git
           haxelib git fnf-modcharting-tools https://github.com/EdwhakKB/FNF-Modcharting-Tools
           haxelib install flixel-screenshot-plugin
@@ -144,7 +146,8 @@ jobs:
           haxelib install away3d
           haxelib git hxNoise https://github.com/whuop/hxNoise
           haxelib install hxvlc
-          haxelib git openfl https://github.com/openfl/openfl
+          haxelib install openfl
+          haxelib install dox
           haxelib git discord_rpc https://github.com/Aidan63/linc_discord-rpc
           haxelib git flixelTextureAtlas https://github.com/Smokey555/Flixel-TextureAtlas.git
           haxelib git fnf-modcharting-tools https://github.com/EdwhakKB/FNF-Modcharting-Tools
@@ -189,6 +192,7 @@ jobs:
           haxelib install flixel-ui
           haxelib install flixel-addons
           haxelib install systools
+          haxelib install dox
           haxelib git linc_luajit https://github.com/Leather128/linc_luajit.git
           haxelib git hscript-improved https://github.com/FNF-CNE-Devs/hscript-improved
           haxelib git HxWebView https://github.com/Vortex2Oblivion/HxWebView

diff --git a/.gitignore b/.gitignore
@@ -2,4 +2,6 @@ export/
 art/flashFiles/RECOVER_*
 crash/export/
 .*/
-!.github
+!.github
+pages/
+docs/doc.xml
diff --git a/Project.xml b/Project.xml
@@ -115,6 +115,7 @@
 	<haxelib name="away3d" if="THREE_D_ALLOWED" />
 	<haxelib name="hxvlc" if="VIDEOS_ALLOWED" />
 	<haxelib name="HxWebView" if="cpp" />
+	<haxelib name="dox"/>
 	<haxelib name="hxNoise"/>
 	<haxelib name="systools" if="cpp" />
 	<haxelib name="fnf-modcharting-tools" url="https://github.com/EdwhakKB/FNF-Modcharting-Tools" />

diff --git a/docs/docs.hxml b/docs/docs.hxml
@@ -1,63 +1,76 @@
 -D openfl
--D flixel=5.5.0
+-D flixel
 -D lime
--D hscript-improved
+-D hscript
 -D flixel-addons
 -D flixel-ui
+-D hscript-improved
 -D tjson
--D scriptless-polymod
+-D hxNoise
 -D flxanimate
 -D flixelTextureAtlas
--D discord_rpc
--D linc_luajit
--D flixel-screenshot-plugin
+-D scriptless-polymod
+-D HxWebView
+-D hxcpp-debug-server
+-D hxcpp
 -D away3d
+-D linc_luajit
 -D hxvlc
--D HxWebView
--D hxNoise
 -D systools
 -D fnf-modcharting-tools
 
+
+
+
 -L lime
 -L openfl
 -L flixel
 -L hscript-improved
+-L flixel-addons
+-L hxNoise
 -L tjson
--L scriptless-polymod
+-L flixel-ui
 -L flxanimate
 -L flixelTextureAtlas
--L discord_rpc
--L linc_luajit
--L flixel-screenshot-plugin
+-L scriptless-polymod 
+-L HxWebView
+-L hxcpp-debug-server
+-L hxcpp
 -L away3d
+-L linc_luajit
 -L hxvlc
--L HxWebView
--L hxNoise
 -L systools
 -L fnf-modcharting-tools
 
 
 
-
-
 --macro lime._internal.macros.DefineMacro.run()
 --macro openfl.utils._internal.ExtraParamsMacro.include()
 --remap flash:openfl
 --macro flixel.system.macros.FlxDefines.run()
 
 -cp source
 
---macro include('flx3D')
+--define polymod
+--define THREE_D_ALLOWED
+--define LUA_ALLOWED
+--define VIDEOS_ALLOWED
+--define LEATHER
+
+
+--macro include('external')
 --macro include('game')
 --macro include('modding')
---macro include('models')
 --macro include('shaders')
 --macro include('states')
 --macro include('substates')
---macro include('tools')
 --macro include('ui')
 --macro include('utilities')
---macro keep('main')
+--macro include('toolbox')
+--macro include('models')
+
+
+--macro keep('Main')
 
 --no-output
 

diff --git a/docs/docs.sh b/docs/docs.sh
@@ -1,4 +1,4 @@
 #! /bin/sh
 
 haxe docs/docs.hxml
-haxelib run dox -i docs -o pages --title "Leather Engine Documentation"
+haxelib run dox -i docs -o pages --title "Leather Engine Documentation" -ex .*^ -in /*  
diff --git a/source/modding/SwitchModSubstate.hx b/source/modding/SwitchModSubstate.hx
@@ -14,10 +14,10 @@ import utilities.MusicUtilities;
 import ui.Option;
 import ui.Checkbox;
 import flixel.group.FlxGroup;
-import tools.ChartingState;
-import tools.StageMakingState;
+import toolbox.ChartingState;
+import toolbox.StageMakingState;
 import flixel.sound.FlxSound;
-import tools.CharacterCreator;
+import toolbox.CharacterCreator;
 import utilities.Controls.Control;
 import flash.text.TextField;
 import flixel.FlxG;
@@ -31,7 +31,7 @@ import flixel.util.FlxColor;
 import lime.utils.Assets;
 import ui.Alphabet;
 import game.Song;
-import tools.StageMakingState;
+import toolbox.StageMakingState;
 import game.Highscore;
 
 class SwitchModSubstate extends MusicBeatSubstate

diff --git a/source/models/Model.hx b/source/models/Model.hx
@@ -1,3 +1,4 @@
+#if THREE_D_ALLOWED
 package models;
 import away3d.entities.Mesh;
 import away3d.events.Asset3DEvent;
@@ -77,4 +78,5 @@ class Model extends FlxView3D {
 	{
 		super.destroy();
 	}
-}
+}
+#end
diff --git a/source/models/Scene3D.hx b/source/models/Scene3D.hx
@@ -1,3 +1,4 @@
+#if THREE_D_ALLOWED
 package models;
 
 import away3d.core.base.Geometry;
@@ -315,4 +316,5 @@ class Scene3D extends FlxView3D
         view.scene.addChild(spr3D);
         return spr3D;
     }
-}
+}
+#end
diff --git a/source/states/MainMenuState.hx b/source/states/MainMenuState.hx
@@ -2,7 +2,6 @@ package states;
 
 import modding.scripts.languages.HScript;
 import flixel.system.debug.interaction.tools.Tool;
-import tools.toolbox.Toolbox;
 import utilities.Options;
 import flixel.util.FlxTimer;
 import game.Replay;
@@ -297,7 +296,7 @@ class MainMenuState extends MusicBeatState
 				FlxG.switchState(new ReplaySelectorState());
 			#end
 			case 'toolbox':
-				FlxG.switchState(new tools.toolbox.ToolboxPlaceholder());
+				FlxG.switchState(new toolbox.ToolboxPlaceholder());
 		}
 		allScriptCall("changeState");
 	}

diff --git a/source/states/ModsMenu.hx b/source/states/ModsMenu.hx
@@ -12,10 +12,10 @@ import utilities.MusicUtilities;
 import ui.Option;
 import ui.Checkbox;
 import flixel.group.FlxGroup;
-import tools.ChartingState;
-import tools.StageMakingState;
+import toolbox.ChartingState;
+import toolbox.StageMakingState;
 import flixel.sound.FlxSound;
-import tools.CharacterCreator;
+import toolbox.CharacterCreator;
 import utilities.Controls.Control;
 import flash.text.TextField;
 import flixel.FlxG;
@@ -29,7 +29,7 @@ import flixel.util.FlxColor;
 import lime.utils.Assets;
 import ui.Alphabet;
 import game.Song;
-import tools.StageMakingState;
+import toolbox.StageMakingState;
 import game.Highscore;
 
 class ModsMenu extends MusicBeatState

diff --git a/source/states/OptionsMenu.hx b/source/states/OptionsMenu.hx
@@ -9,10 +9,10 @@ import utilities.MusicUtilities;
 import ui.Option;
 import ui.Checkbox;
 import flixel.group.FlxGroup;
-import tools.ChartingState;
-import tools.StageMakingState;
+import toolbox.ChartingState;
+import toolbox.StageMakingState;
 import flixel.sound.FlxSound;
-import tools.CharacterCreator;
+import toolbox.CharacterCreator;
 import utilities.Controls.Control;
 import flash.text.TextField;
 import flixel.FlxG;
@@ -26,10 +26,9 @@ import flixel.util.FlxColor;
 import lime.utils.Assets;
 import ui.Alphabet;
 import game.Song;
-import tools.StageMakingState;
+import toolbox.StageMakingState;
 import game.Highscore;
 import openfl.utils.Assets as OpenFLAssets;
-import tools.ChartingStateDev;
 
 class OptionsMenu extends MusicBeatState {
 	var curSelected:Int = 0;

diff --git a/source/states/PlayState.hx b/source/states/PlayState.hx
@@ -27,7 +27,6 @@ import flixel.util.FlxStringUtil;
 import openfl.display.BitmapData;
 import flixel.graphics.FlxGraphic;
 import flixel.system.FlxAssets.FlxShader;
-import flixel.addons.display.FlxShaderMaskCamera;
 import substates.ResultsScreenSubstate;
 import haxe.Json;
 import game.Replay;
@@ -43,7 +42,7 @@ import utilities.NoteVariables;
 import flixel.input.FlxInput.FlxInputState;
 import flixel.group.FlxGroup;
 import utilities.Ratings;
-import tools.ChartingState;
+import toolbox.ChartingState;
 import game.Section.SwagSection;
 import flixel.FlxBasic;
 import flixel.FlxCamera;
@@ -2942,9 +2941,9 @@ class PlayState extends MusicBeatState {
 				SONG.keyCount = ogKeyCount;
 				SONG.playerKeyCount = ogPlayerKeyCount;
 
-				FlxG.switchState(new tools.CharacterCreator(SONG.player2, curStage));
+				FlxG.switchState(new toolbox.CharacterCreator(SONG.player2, curStage));
 
-				tools.CharacterCreator.lastState = "PlayState";
+				toolbox.CharacterCreator.lastState = "PlayState";
 
 				#if discord_rpc
 				DiscordClient.changePresence("Creating A Character", null, null, true);

diff --git a/source/tools/CharacterCreator.hx → source/toolbox/CharacterCreator.hx b/source/tools/CharacterCreator.hx → source/toolbox/CharacterCreator.hx
@@ -1,4 +1,4 @@
-package tools;
+package toolbox;
 
 #if discord_rpc
 import utilities.Discord.DiscordClient;

diff --git a/source/tools/ChartingState.hx → source/toolbox/ChartingState.hx b/source/tools/ChartingState.hx → source/toolbox/ChartingState.hx
@@ -1,4 +1,4 @@
-package tools;
+package toolbox;
 
 import flixel.util.FlxTimer;
 import flixel.FlxObject;

diff --git a/source/tools/StageMakingState.hx → source/toolbox/StageMakingState.hx b/source/tools/StageMakingState.hx → source/toolbox/StageMakingState.hx
@@ -1,4 +1,4 @@
-package tools;
+package toolbox;
 
 import flixel.addons.ui.FlxUIInputText;
 import flixel.addons.ui.FlxUINumericStepper;

diff --git a/source/tools/toolbox/ToolboxPlaceholder.hx → source/toolbox/ToolboxPlaceholder.hx b/source/tools/toolbox/ToolboxPlaceholder.hx → source/toolbox/ToolboxPlaceholder.hx
@@ -1,4 +1,4 @@
-package tools.toolbox;
+package toolbox;
 
 import states.MainMenuState;
 import states.MusicBeatState;
@@ -12,10 +12,10 @@ import utilities.MusicUtilities;
 import ui.Option;
 import ui.Checkbox;
 import flixel.group.FlxGroup;
-import tools.ChartingState;
-import tools.StageMakingState;
+import toolbox.ChartingState;
+import toolbox.StageMakingState;
 import flixel.sound.FlxSound;
-import tools.CharacterCreator;
+import toolbox.CharacterCreator;
 import utilities.Controls.Control;
 import flash.text.TextField;
 import flixel.FlxG;
@@ -29,10 +29,9 @@ import flixel.util.FlxColor;
 import lime.utils.Assets;
 import ui.Alphabet;
 import game.Song;
-import tools.StageMakingState;
+import toolbox.StageMakingState;
 import game.Highscore;
 import openfl.utils.Assets as OpenFLAssets;
-import tools.ChartingStateDev;
 
 class ToolboxPlaceholder extends states.MusicBeatState {
 	var curSelected:Int = 0;
@@ -163,4 +162,4 @@ class ToolboxPlaceholder extends states.MusicBeatState {
 			}
 		}
 	}
-}
+}