From 41e66d8ea323ed7c4f1fb44e783dd9a71a1e5d8e Mon Sep 17 00:00:00 2001 From: Cooldude2606 <25043174+Cooldude2606@users.noreply.github.com> Date: Tue, 16 Jan 2024 01:04:24 +0000 Subject: [PATCH] New docs deploy process --- .github/workflows/dev-deploy.yml | 39 - .github/workflows/docs-deploy.yml | 64 + docs/addons/Advanced-Start.html | 360 -- docs/addons/Chat-Popups.html | 389 -- docs/addons/Chat-Reply.html | 388 -- docs/addons/Compilatron.html | 597 --- docs/addons/Damage-Popups.html | 389 -- docs/addons/Death-Logger.html | 416 -- docs/addons/Deconlog.html | 388 -- docs/addons/Discord-Alerts.html | 500 -- docs/addons/FAGC.html | 332 -- docs/addons/Inventory-Clear.html | 388 -- docs/addons/Nukeprotect.html | 416 -- docs/addons/Player-Colours.html | 417 -- docs/addons/Pollution-Grading.html | 360 -- docs/addons/Scorched-Earth.html | 416 -- docs/addons/Spawn-Area.html | 388 -- docs/addons/Tree-Decon.html | 444 -- docs/addons/afk-kick.html | 416 -- docs/addons/greetings.html | 389 -- docs/addons/protection-jail.html | 444 -- docs/addons/report-jail.html | 416 -- docs/commands/Admin-Chat.html | 428 -- docs/commands/Admin-Markers.html | 433 -- docs/commands/Bonus.html | 513 -- docs/commands/Cheat-Mode.html | 401 -- docs/commands/Clear-Inventory.html | 428 -- docs/commands/Connect.html | 631 --- docs/commands/Debug.html | 405 -- docs/commands/Find.html | 400 -- docs/commands/Help.html | 444 -- docs/commands/Home.html | 498 -- docs/commands/Interface.html | 428 -- docs/commands/InventorySearch.html | 618 --- docs/commands/Jail.html | 527 -- docs/commands/Kill.html | 429 -- docs/commands/LastLocation.html | 428 -- docs/commands/Me.html | 400 -- docs/commands/Protection.html | 576 --- docs/commands/Quickbar.html | 409 -- docs/commands/Rainbow.html | 428 -- docs/commands/Repair.html | 361 -- docs/commands/Reports.html | 625 --- docs/commands/Roles.html | 597 --- docs/commands/Spawn.html | 429 -- docs/commands/Spectate.html | 459 -- docs/commands/Tag.html | 456 -- docs/commands/Teleport.html | 524 -- docs/commands/Warnings.html | 609 --- docs/configs/Advanced-Start.html | 546 -- docs/configs/Autofill.html | 277 - docs/configs/Bonuses.html | 277 - docs/configs/Chat-Reply.html | 525 -- docs/configs/Commands-Auth-Admin.html | 334 -- docs/configs/Commands-Auth-Roles.html | 360 -- .../Commands-Auth-Runtime-Disable.html | 482 -- docs/configs/Commands-Color-Parse.html | 360 -- docs/configs/Commands-Parse-Roles.html | 394 -- docs/configs/Commands-Parse.html | 350 -- docs/configs/Commands.auth_admin.html | 289 -- docs/configs/Commands.auth_roles.html | 315 -- .../Commands.auth_runtime_disable.html | 437 -- docs/configs/Commands.parse_general.html | 333 -- docs/configs/Commands.parse_roles.html | 349 -- docs/configs/Compilatron.html | 394 -- docs/configs/Death-Logger.html | 516 -- docs/configs/Deconlog.html | 484 -- docs/configs/Discord-Alerts.html | 277 - docs/configs/File-Loader.html | 280 -- docs/configs/Permission-Groups.html | 335 -- docs/configs/Player-List.html | 734 --- docs/configs/Pollution-Grading.html | 424 -- docs/configs/Popup-Messages.html | 454 -- docs/configs/Preset-Player-Colours.html | 364 -- docs/configs/Preset-Player-Quickbar.html | 277 - docs/configs/Repair.html | 454 -- docs/configs/Rockets.html | 874 ---- docs/configs/Roles.html | 360 -- docs/configs/Science.html | 394 -- docs/configs/Scorched-Earth.html | 428 -- docs/configs/Spawn-Area.html | 1235 ----- docs/configs/Statistics.html | 694 --- docs/configs/Tasks.html | 424 -- docs/configs/Warnings.html | 395 -- docs/configs/Warps.html | 784 --- docs/configs/inventory_clear.html | 277 - docs/control/Jail.html | 815 --- docs/control/Production.html | 1369 ----- docs/control/Protection.html | 1041 ---- docs/control/Reports.html | 1182 ----- docs/control/Rockets.html | 1024 ---- docs/control/Selection.html | 931 ---- docs/control/Tasks.html | 1025 ---- docs/control/Warnings.html | 1565 ------ docs/control/Warps.html | 1547 ------ docs/core/Async.html | 638 --- docs/core/Commands.html | 2453 --------- docs/core/Common-Library.html | 2828 ----------- docs/core/Common.html | 2900 ----------- docs/core/Datastore.html | 2989 ----------- docs/core/ExpStyle.html | 1366 ----- docs/core/External.html | 773 --- docs/core/Groups.html | 1468 ------ docs/core/Gui.html | 4446 ----------------- docs/core/Permissions-Groups.html | 1435 ------ docs/core/PlayerData.html | 556 --- docs/core/Roles.html | 3416 ------------- docs/core/Store.html | 1503 ------ docs/core/Sudo.html | 552 -- docs/core/Toolbar.html | 1669 ------- docs/data/Alt-View.html | 360 -- docs/data/Bonus.html | 512 -- docs/data/Greetings.html | 455 -- docs/data/Player-Colours.html | 416 -- docs/data/Quickbar.html | 433 -- docs/data/Tag.html | 565 --- docs/guis/Autofill.html | 617 --- docs/guis/Player-List.html | 731 --- docs/guis/Readme.html | 1023 ---- docs/guis/Rocket-Info.html | 731 --- docs/guis/Science-Info.html | 610 --- docs/guis/Task-List.html | 1134 ----- docs/guis/Warps-List.html | 1100 ---- docs/guis/server-ups.html | 533 -- docs/index.html | 634 --- docs/modules/ExpStyle.html | 1343 ----- docs/modules/Gui.html | 4332 ---------------- docs/modules/Jail.html | 1169 ----- docs/modules/Production.html | 1281 ----- docs/modules/Reports.html | 1026 ---- docs/modules/Warnings.html | 1279 ----- docs/modules/addons.advanced-start.html | 71 - docs/modules/addons.chat-popups.html | 72 - docs/modules/addons.damage-popups.html | 72 - docs/modules/config._file_loader.html | 235 - docs/modules/config.action_buttons.html | 515 -- docs/modules/config.advanced_start.html | 232 - docs/modules/config.bonuses.html | 232 - docs/modules/config.chat_reply.html | 287 -- docs/modules/config.death_logger.html | 234 - docs/modules/config.discord_alerts.html | 233 - .../config.expcore-commands.auth_admin.html | 282 -- .../config.expcore-commands.auth_roles.html | 315 -- ...expcore-commands.auth_runtime_disable.html | 316 -- ...config.expcore-commands.parse_general.html | 319 -- .../config.expcore-commands.parse_roles.html | 343 -- docs/modules/config.permission_groups.html | 347 -- docs/modules/config.popup_messages.html | 234 - docs/modules/config.rockets.html | 324 -- docs/modules/config.roles.html | 290 -- docs/modules/config.scorched_earth.html | 235 - docs/modules/config.spawn_area.html | 235 - docs/modules/config.warnings.html | 235 - docs/modules/config.warps.html | 235 - docs/modules/control.html | 280 -- docs/modules/control.reports.html | 341 -- docs/modules/expcore.commands.html | 264 - docs/modules/expcore.common.html | 2444 --------- docs/modules/expcore.gui.buttons.html | 275 - docs/modules/expcore.gui.center.html | 472 -- docs/modules/expcore.gui.checkboxs.html | 414 -- docs/modules/expcore.gui.concepts.center.html | 1126 ----- docs/modules/expcore.gui.concepts.left.html | 1476 ------ docs/modules/expcore.gui.concepts.popups.html | 1012 ---- .../modules/expcore.gui.concepts.toolbar.html | 635 --- docs/modules/expcore.gui.core.html | 260 - docs/modules/expcore.gui.dropdown.html | 366 -- docs/modules/expcore.gui.elem-button.html | 224 - .../modules/expcore.gui.elements.buttons.html | 694 --- .../expcore.gui.elements.checkbox.html | 1040 ---- .../expcore.gui.elements.checkboxs.html | 848 ---- .../expcore.gui.elements.dropdown.html | 874 ---- .../expcore.gui.elements.elem-button.html | 570 --- .../expcore.gui.elements.progress-bar.html | 1343 ----- docs/modules/expcore.gui.elements.slider.html | 673 --- docs/modules/expcore.gui.elements.text.html | 691 --- docs/modules/expcore.gui.html | 246 - docs/modules/expcore.gui.instances.html | 259 - docs/modules/expcore.gui.left.html | 573 --- docs/modules/expcore.gui.popups.html | 352 -- docs/modules/expcore.gui.progress-bar.html | 557 --- docs/modules/expcore.gui.prototype.html | 1588 ------ docs/modules/expcore.gui.slider.html | 288 -- docs/modules/expcore.gui.test.html | 429 -- docs/modules/expcore.gui.text.html | 290 -- docs/modules/expcore.gui.toolbar.html | 212 - docs/modules/expcore.permission_groups.html | 1394 ------ docs/modules/expcore.roles.html | 2981 ----------- docs/modules/expcore.store.html | 972 ---- docs/modules/expcore.sudo.html | 254 - docs/modules/gui.player-list.html | 71 - docs/modules/gui.rocket-info.html | 100 - docs/modules/gui.science-info.html | 71 - docs/modules/gui.task-list.html | 71 - .../modules.addons.advanced-start.html | 349 -- docs/modules/modules.addons.chat-popups.html | 350 -- .../modules/modules.addons.damage-popups.html | 350 -- .../modules.addons.station-auto-name.html | 333 -- docs/modules/modules.control.production.html | 1281 ----- docs/modules/modules.control.reports.html | 1026 ---- docs/modules/modules.control.warnings.html | 1416 ------ docs/modules/modules.gui.player-list.html | 449 -- docs/modules/modules.gui.rocket-info.html | 465 -- docs/modules/modules.gui.science-info.html | 365 -- docs/modules/modules.gui.task-list.html | 393 -- docs/modules/overrides.debug.html | 694 --- docs/modules/overrides.math.html | 393 -- docs/modules/overrides.table.html | 2048 -------- docs/modules/tesrt.html | 386 -- .../utils.alien_evolution_progress.html | 427 -- docs/modules/utils.core.html | 1172 ----- docs/modules/utils.debug.html | 662 --- docs/modules/utils.dump_env.html | 331 -- docs/modules/utils.event.html | 1332 ----- docs/modules/utils.event_core.html | 474 -- docs/modules/utils.math.html | 361 -- docs/modules/utils.recipe_locker.html | 449 -- docs/modules/utils.state_machine.html | 760 --- docs/modules/utils.table.html | 1426 ------ docs/modules/utils.task.html | 691 --- docs/modules/utils.timestamp.html | 450 -- docs/topics/LICENSE.html | 829 --- docs/topics/README.md.html | 390 -- 223 files changed, 64 insertions(+), 150412 deletions(-) delete mode 100644 .github/workflows/dev-deploy.yml create mode 100644 .github/workflows/docs-deploy.yml delete mode 100644 docs/addons/Advanced-Start.html delete mode 100644 docs/addons/Chat-Popups.html delete mode 100644 docs/addons/Chat-Reply.html delete mode 100644 docs/addons/Compilatron.html delete mode 100644 docs/addons/Damage-Popups.html delete mode 100644 docs/addons/Death-Logger.html delete mode 100644 docs/addons/Deconlog.html delete mode 100644 docs/addons/Discord-Alerts.html delete mode 100644 docs/addons/FAGC.html delete mode 100644 docs/addons/Inventory-Clear.html delete mode 100644 docs/addons/Nukeprotect.html delete mode 100644 docs/addons/Player-Colours.html delete mode 100644 docs/addons/Pollution-Grading.html delete mode 100644 docs/addons/Scorched-Earth.html delete mode 100644 docs/addons/Spawn-Area.html delete mode 100644 docs/addons/Tree-Decon.html delete mode 100644 docs/addons/afk-kick.html delete mode 100644 docs/addons/greetings.html delete mode 100644 docs/addons/protection-jail.html delete mode 100644 docs/addons/report-jail.html delete mode 100644 docs/commands/Admin-Chat.html delete mode 100644 docs/commands/Admin-Markers.html delete mode 100644 docs/commands/Bonus.html delete mode 100644 docs/commands/Cheat-Mode.html delete mode 100644 docs/commands/Clear-Inventory.html delete mode 100644 docs/commands/Connect.html delete mode 100644 docs/commands/Debug.html delete mode 100644 docs/commands/Find.html delete mode 100644 docs/commands/Help.html delete mode 100644 docs/commands/Home.html delete mode 100644 docs/commands/Interface.html delete mode 100644 docs/commands/InventorySearch.html delete mode 100644 docs/commands/Jail.html delete mode 100644 docs/commands/Kill.html delete mode 100644 docs/commands/LastLocation.html delete mode 100644 docs/commands/Me.html delete mode 100644 docs/commands/Protection.html delete mode 100644 docs/commands/Quickbar.html delete mode 100644 docs/commands/Rainbow.html delete mode 100644 docs/commands/Repair.html delete mode 100644 docs/commands/Reports.html delete mode 100644 docs/commands/Roles.html delete mode 100644 docs/commands/Spawn.html delete mode 100644 docs/commands/Spectate.html delete mode 100644 docs/commands/Tag.html delete mode 100644 docs/commands/Teleport.html delete mode 100644 docs/commands/Warnings.html delete mode 100644 docs/configs/Advanced-Start.html delete mode 100644 docs/configs/Autofill.html delete mode 100644 docs/configs/Bonuses.html delete mode 100644 docs/configs/Chat-Reply.html delete mode 100644 docs/configs/Commands-Auth-Admin.html delete mode 100644 docs/configs/Commands-Auth-Roles.html delete mode 100644 docs/configs/Commands-Auth-Runtime-Disable.html delete mode 100644 docs/configs/Commands-Color-Parse.html delete mode 100644 docs/configs/Commands-Parse-Roles.html delete mode 100644 docs/configs/Commands-Parse.html delete mode 100644 docs/configs/Commands.auth_admin.html delete mode 100644 docs/configs/Commands.auth_roles.html delete mode 100644 docs/configs/Commands.auth_runtime_disable.html delete mode 100644 docs/configs/Commands.parse_general.html delete mode 100644 docs/configs/Commands.parse_roles.html delete mode 100644 docs/configs/Compilatron.html delete mode 100644 docs/configs/Death-Logger.html delete mode 100644 docs/configs/Deconlog.html delete mode 100644 docs/configs/Discord-Alerts.html delete mode 100644 docs/configs/File-Loader.html delete mode 100644 docs/configs/Permission-Groups.html delete mode 100644 docs/configs/Player-List.html delete mode 100644 docs/configs/Pollution-Grading.html delete mode 100644 docs/configs/Popup-Messages.html delete mode 100644 docs/configs/Preset-Player-Colours.html delete mode 100644 docs/configs/Preset-Player-Quickbar.html delete mode 100644 docs/configs/Repair.html delete mode 100644 docs/configs/Rockets.html delete mode 100644 docs/configs/Roles.html delete mode 100644 docs/configs/Science.html delete mode 100644 docs/configs/Scorched-Earth.html delete mode 100644 docs/configs/Spawn-Area.html delete mode 100644 docs/configs/Statistics.html delete mode 100644 docs/configs/Tasks.html delete mode 100644 docs/configs/Warnings.html delete mode 100644 docs/configs/Warps.html delete mode 100644 docs/configs/inventory_clear.html delete mode 100644 docs/control/Jail.html delete mode 100644 docs/control/Production.html delete mode 100644 docs/control/Protection.html delete mode 100644 docs/control/Reports.html delete mode 100644 docs/control/Rockets.html delete mode 100644 docs/control/Selection.html delete mode 100644 docs/control/Tasks.html delete mode 100644 docs/control/Warnings.html delete mode 100644 docs/control/Warps.html delete mode 100644 docs/core/Async.html delete mode 100644 docs/core/Commands.html delete mode 100644 docs/core/Common-Library.html delete mode 100644 docs/core/Common.html delete mode 100644 docs/core/Datastore.html delete mode 100644 docs/core/ExpStyle.html delete mode 100644 docs/core/External.html delete mode 100644 docs/core/Groups.html delete mode 100644 docs/core/Gui.html delete mode 100644 docs/core/Permissions-Groups.html delete mode 100644 docs/core/PlayerData.html delete mode 100644 docs/core/Roles.html delete mode 100644 docs/core/Store.html delete mode 100644 docs/core/Sudo.html delete mode 100644 docs/core/Toolbar.html delete mode 100644 docs/data/Alt-View.html delete mode 100644 docs/data/Bonus.html delete mode 100644 docs/data/Greetings.html delete mode 100644 docs/data/Player-Colours.html delete mode 100644 docs/data/Quickbar.html delete mode 100644 docs/data/Tag.html delete mode 100644 docs/guis/Autofill.html delete mode 100644 docs/guis/Player-List.html delete mode 100644 docs/guis/Readme.html delete mode 100644 docs/guis/Rocket-Info.html delete mode 100644 docs/guis/Science-Info.html delete mode 100644 docs/guis/Task-List.html delete mode 100644 docs/guis/Warps-List.html delete mode 100644 docs/guis/server-ups.html delete mode 100644 docs/index.html delete mode 100644 docs/modules/ExpStyle.html delete mode 100644 docs/modules/Gui.html delete mode 100644 docs/modules/Jail.html delete mode 100644 docs/modules/Production.html delete mode 100644 docs/modules/Reports.html delete mode 100644 docs/modules/Warnings.html delete mode 100644 docs/modules/addons.advanced-start.html delete mode 100644 docs/modules/addons.chat-popups.html delete mode 100644 docs/modules/addons.damage-popups.html delete mode 100644 docs/modules/config._file_loader.html delete mode 100644 docs/modules/config.action_buttons.html delete mode 100644 docs/modules/config.advanced_start.html delete mode 100644 docs/modules/config.bonuses.html delete mode 100644 docs/modules/config.chat_reply.html delete mode 100644 docs/modules/config.death_logger.html delete mode 100644 docs/modules/config.discord_alerts.html delete mode 100644 docs/modules/config.expcore-commands.auth_admin.html delete mode 100644 docs/modules/config.expcore-commands.auth_roles.html delete mode 100644 docs/modules/config.expcore-commands.auth_runtime_disable.html delete mode 100644 docs/modules/config.expcore-commands.parse_general.html delete mode 100644 docs/modules/config.expcore-commands.parse_roles.html delete mode 100644 docs/modules/config.permission_groups.html delete mode 100644 docs/modules/config.popup_messages.html delete mode 100644 docs/modules/config.rockets.html delete mode 100644 docs/modules/config.roles.html delete mode 100644 docs/modules/config.scorched_earth.html delete mode 100644 docs/modules/config.spawn_area.html delete mode 100644 docs/modules/config.warnings.html delete mode 100644 docs/modules/config.warps.html delete mode 100644 docs/modules/control.html delete mode 100644 docs/modules/control.reports.html delete mode 100644 docs/modules/expcore.commands.html delete mode 100644 docs/modules/expcore.common.html delete mode 100644 docs/modules/expcore.gui.buttons.html delete mode 100644 docs/modules/expcore.gui.center.html delete mode 100644 docs/modules/expcore.gui.checkboxs.html delete mode 100644 docs/modules/expcore.gui.concepts.center.html delete mode 100644 docs/modules/expcore.gui.concepts.left.html delete mode 100644 docs/modules/expcore.gui.concepts.popups.html delete mode 100644 docs/modules/expcore.gui.concepts.toolbar.html delete mode 100644 docs/modules/expcore.gui.core.html delete mode 100644 docs/modules/expcore.gui.dropdown.html delete mode 100644 docs/modules/expcore.gui.elem-button.html delete mode 100644 docs/modules/expcore.gui.elements.buttons.html delete mode 100644 docs/modules/expcore.gui.elements.checkbox.html delete mode 100644 docs/modules/expcore.gui.elements.checkboxs.html delete mode 100644 docs/modules/expcore.gui.elements.dropdown.html delete mode 100644 docs/modules/expcore.gui.elements.elem-button.html delete mode 100644 docs/modules/expcore.gui.elements.progress-bar.html delete mode 100644 docs/modules/expcore.gui.elements.slider.html delete mode 100644 docs/modules/expcore.gui.elements.text.html delete mode 100644 docs/modules/expcore.gui.html delete mode 100644 docs/modules/expcore.gui.instances.html delete mode 100644 docs/modules/expcore.gui.left.html delete mode 100644 docs/modules/expcore.gui.popups.html delete mode 100644 docs/modules/expcore.gui.progress-bar.html delete mode 100644 docs/modules/expcore.gui.prototype.html delete mode 100644 docs/modules/expcore.gui.slider.html delete mode 100644 docs/modules/expcore.gui.test.html delete mode 100644 docs/modules/expcore.gui.text.html delete mode 100644 docs/modules/expcore.gui.toolbar.html delete mode 100644 docs/modules/expcore.permission_groups.html delete mode 100644 docs/modules/expcore.roles.html delete mode 100644 docs/modules/expcore.store.html delete mode 100644 docs/modules/expcore.sudo.html delete mode 100644 docs/modules/gui.player-list.html delete mode 100644 docs/modules/gui.rocket-info.html delete mode 100644 docs/modules/gui.science-info.html delete mode 100644 docs/modules/gui.task-list.html delete mode 100644 docs/modules/modules.addons.advanced-start.html delete mode 100644 docs/modules/modules.addons.chat-popups.html delete mode 100644 docs/modules/modules.addons.damage-popups.html delete mode 100644 docs/modules/modules.addons.station-auto-name.html delete mode 100644 docs/modules/modules.control.production.html delete mode 100644 docs/modules/modules.control.reports.html delete mode 100644 docs/modules/modules.control.warnings.html delete mode 100644 docs/modules/modules.gui.player-list.html delete mode 100644 docs/modules/modules.gui.rocket-info.html delete mode 100644 docs/modules/modules.gui.science-info.html delete mode 100644 docs/modules/modules.gui.task-list.html delete mode 100644 docs/modules/overrides.debug.html delete mode 100644 docs/modules/overrides.math.html delete mode 100644 docs/modules/overrides.table.html delete mode 100644 docs/modules/tesrt.html delete mode 100644 docs/modules/utils.alien_evolution_progress.html delete mode 100644 docs/modules/utils.core.html delete mode 100644 docs/modules/utils.debug.html delete mode 100644 docs/modules/utils.dump_env.html delete mode 100644 docs/modules/utils.event.html delete mode 100644 docs/modules/utils.event_core.html delete mode 100644 docs/modules/utils.math.html delete mode 100644 docs/modules/utils.recipe_locker.html delete mode 100644 docs/modules/utils.state_machine.html delete mode 100644 docs/modules/utils.table.html delete mode 100644 docs/modules/utils.task.html delete mode 100644 docs/modules/utils.timestamp.html delete mode 100644 docs/topics/LICENSE.html delete mode 100644 docs/topics/README.md.html diff --git a/.github/workflows/dev-deploy.yml b/.github/workflows/dev-deploy.yml deleted file mode 100644 index d1773da3..00000000 --- a/.github/workflows/dev-deploy.yml +++ /dev/null @@ -1,39 +0,0 @@ -name: Dev Deploy - -on: - push: - branches: - - dev - paths-ignore: - - 'docs/**' - - '.luacheckrc' - -jobs: - deploy: - runs-on: ubuntu-latest - steps: - - name: Checkout repo - uses: actions/checkout@v2 - with: - fetch-depth: 0 - - - name: Install Lua - uses: leafo/gh-actions-lua@v8.0.0 - - - name: Install LuaRocks - uses: leafo/gh-actions-luarocks@v4 - - - name: Install LDoc - run: luarocks install ldoc 1.4.4-1 - - - name: Generate Documents - working-directory: docs - run: ldoc -i . - - - name: Commit changes - uses: EndBug/add-and-commit@v4 - with: - message: "Automatic Doc Update" - add: "./docs/** .luacheckrc" - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/docs-deploy.yml b/.github/workflows/docs-deploy.yml new file mode 100644 index 00000000..61769368 --- /dev/null +++ b/.github/workflows/docs-deploy.yml @@ -0,0 +1,64 @@ +name: Docs Deploy + +on: + # Deploy when there is a push to dev + push: + branches: + - dev + + # Allow runing this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout Repo + uses: actions/checkout@v4 + + - name: Install Lua + uses: leafo/gh-actions-lua@v8.0.0 + + - name: Install LuaRocks + uses: leafo/gh-actions-luarocks@v4 + + - name: Install LDoc + run: luarocks install ldoc 1.4.4-1 + + - name: Create Docs Folder + run: mkdir -p docs + + - name: Generate Documents + working-directory: docs + run: ldoc -i . + + - name: Setup Pages + uses: actions/configure-pages@v4 + + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: ./docs + + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/docs/addons/Advanced-Start.html b/docs/addons/Advanced-Start.html deleted file mode 100644 index da405ff5..00000000 --- a/docs/addons/Advanced-Start.html +++ /dev/null @@ -1,360 +0,0 @@ - - - - -
- - -Adds a better method of player starting items based on production levels.
- - - - - - - - - - - - -| utils.event | -
| config.advanced_start | -
Creates flying text entities when a player sends a message in chat; - also displays a ping above users who are named in the message
- - - - - - - - - - - - -| utils.game | -
| utils.event | -
| config.popup_messages | -
Adds auto replies to chat messages; as well as chat commands
- - - - - - - - - - - - -| utils.event | -
| expcore.roles | -
| config.chat_reply | -
Adds a compilatron that walks around the spawn area; adapted from redmew code
- - - - - - - - - - - - -| utils.event | -
| utils.global | -
| utils.task | -
| utils.token | -
| config.compilatron | -
| Public.add_compilatron(entity, name) | -This will add a compilatron to the global and start his message cycle | -
| Public.spawn_compilatron(surface, location) | -This spawns a new compilatron on a surface with the given location tag (not a position) | -
This will add a compilatron to the global and start his message cycle
- - - - Parameters: - -This spawns a new compilatron on a surface with the given location tag (not a position)
- - - - Parameters: - -Displays the amount of dmg that is done by players to entities; - also shows player health when a player is attacked
- - - - - - - - - - - - -| utils.game | -
| utils.event | -
| config.popup_messages | -
Makes markers on the map where places have died and reclaims items if not recovered
- - - - - - - - - - - - -| utils.event | -
| utils.global | -
| config.death_logger | -
| expcore.common | -
Log certain actions into a file when events are triggered
- - - - - - - - - - - - -| utils.event | -
| expcore.roles | -
| config.deconlog | -
Sends alert messages to our discord server when certain events are triggered
- - - - - - - - - - - - -| utils.event | -
| utils.color_presets | -
| expcore.common | -
| config.discord_alerts | -
| modules.control.protection | -
| modules.control.reports | -
| modules.control.warnings | -
Allows the FAGC clientside bot to receive information about bans and unbans and propagate that information to other servers
- - - - - - - - - - - - -| utils.event | -
Will move players items to spawn when they are banned or kicked, option to clear on leave
- - - - - - - - - - - - -| utils.event | -
| config.inventory_clear | -
| expcore.common | -
Disable new players from having certain items in their inventory, most commonly nukes
- - - - - - - - - - - - -| utils.event | -
| expcore.roles | -
| config.nukeprotect | -
| expcore.common | -
Gives players random colours when they join, also applies preset colours to those who have them
- - - - - - - - - - - - -| utils.color_presets | -
| utils.game | -
| utils.event | -
| config.preset_player_colours | -
| utils.global | -
Makes polution look much nice of the map, ie not one big red mess
- - - - - - - - - - - - -| utils.event | -
| config.pollution_grading | -
When a player walks around the tiles under them will degrade over time, the same is true when entites are built
- - - - - - - - - - - - -| utils.event | -
| utils.global | -
| expcore.common | -
| config.scorched_earth | -
Adds a custom spawn area with chests and afk turrets
- - - - - - - - - - - - -| utils.global | -
| utils.event | -
| config.spawn_area | -
Makes trees which are marked for decon "decay" quickly to allow faster building
- - - - - - - - - - - - -| utils.event | -
| utils.global | -
| expcore.roles | -
| expcore.gui | -
| expcore.player_data | -
Kicks players when all players on the server are afk
- - - - - - - - - - - - -| utils.event | -
| utils.global | -
| config.afk_kick | -
| expcore.async | -
Greets players on join
- - - - - - - - - - - - -| utils.event | -
| utils.event | -
| config.join_messages | -
| utils.global | -
When a player triggers protection multiple times they are automatically jailed
- - - - - - - - - - - - -| utils.event | -
| utils.global | -
| modules.control.jail | -
| modules.control.protection | -
| expcore.common | -
When a player is reported, the player is automatically jailed if the combined playtime of the reporters exceeds the reported player
- - - - - - - - - - - - -| utils.event | -
| modules.control.jail | -
| modules.control.reports | -
| expcore.common | -
Commands Module - Admin Chat - - Adds a command that allows admins to talk in a private chat
- - - - - - - - - - - - -| expcore.commands | -
| expcore.common | -
| admin-chat | -Sends a message in chat that only admins can see | -
Commands Module - Admin Markers - - Adds a command that creates map markers which can only be edited by admins
- - - - - - - - - - - - -| expcore.commands | -
| utils.global | -
| utils.event | -
| admin-marker | -Toggle admin marker mode, can only be applied to yourself | -
Commands Module - Bonus - - Adds a command that allows players to have increased stats
- - - - - - - - - - - - -| expcore.commands | -
| expcore.roles | -
| utils.event | -
| utils.game | -
| expcore.store | -
| config.bonuses | -
| bonus | -Changes the amount of bonus you receive | -
Commands Module - Cheat Mode - - Adds a command that allows players to enter cheat mode
- - - - - - - - - - - - -| expcore.commands | -
| toggle-cheat-mode | -Toggles cheat mode for your player, or another player. | -
Commands Module - Clear Inventory - - Adds a command that allows admins to clear people's inventorys
- - - - - - - - - - - - -| expcore.commands | -
| expcore.common | -
| clear-inventory | -Clears a players inventory | -
Commands Module - Connect - - Adds a commands that allows you to request a player move to another server
- - - - - - - - - - - - -| expcore.async | -
| expcore.external | -
| expcore.commands | -
| connect | -Connect to a different server | -
| connect-player | -Connect a player to a different server | -
| connect-all | -Connect all players to a different server | -
Connect to a different server
- - - - Command Parameters: - -Connect a player to a different server
- - - - Command Parameters: - -Connect all players to a different server
- - - - Command Parameters: - - - - - - - - - - - - - - - - - - - - -Commands Module - Debug - - Adds a command that opens the debug frame
- - - - - - - - - - - - -| modules.gui.debug.main_view | -
| expcore.commands | -
| debug | -Opens the debug pannel for viewing tables. | -
Commands Module - Find - - Adds a command that zooms in on the given player
- - - - - - - - - - - - -| expcore.commands | -
| find-on-map | -Find a player on your map. | -
Commands Module - Help - - Adds a better help command that allows searching of descriotions and names
- - - - - - - - - - - - -| expcore.commands | -
| utils.global | -
| chelp | -Searches for a keyword in all commands you are allowed to use. | -
Commands Module - Home - - Adds a command that allows setting and teleporting to your home position
- - - - - - - - - - - - -| expcore.commands | -
| utils.global | -
| home | -Teleports you to your home location | -
| home-set | -Sets your home location to your current position | -
| home-get | -Returns your current home location | -
| return | -Teleports you to previous location | -
Teleports you to your home location
- - - - - - - - - - - - - - - - -Sets your home location to your current position
- - - - - - - - - - - - - - - - -Returns your current home location
- - - - - - - - - - - - - - - - -Teleports you to previous location
- - - - - - - - - - - - - - - - - - - - -Commands Module - Interface - - Adds a command that acts as a direct link to the the active softmod, for debug use
- - - - - - - - - - - - -| expcore.commands | -
| utils.global | -
| interface | -Sends an invocation to be ran and returns the result. | -
Commands Module - Inventory Search - - Adds commands that will search all players inventories for an item
- - - - - - - - - - - - -| expcore.commands | -
| util | -
| expcore.common | -
| search-amount | -Get a list of players sorted by the quantity of an item in their inventory | -
| search-recent | -Get a list of players who have the given item, sorted by how recently they joined | -
| search | -Get a list of players sorted by quantity held and play time | -
| search-online | -Get a list of online players sorted by quantity held and play time | -
Get a list of players sorted by the quantity of an item in their inventory
- - - - Command Parameters: - -Get a list of players who have the given item, sorted by how recently they joined
- - - - Command Parameters: - -Get a list of players sorted by quantity held and play time
- - - - Command Parameters: - -Get a list of online players sorted by quantity held and play time
- - - - Command Parameters: - -Commands Module - Jail - - Adds a commands that allow admins to jail and unjail
- - - - - - - - - - - - -| expcore.commands | -
| modules.control.jail | -
| expcore.common | -
| jail | -Puts a player into jail and removes all other roles. | -
| unjail | -Removes a player from jail. | -
Puts a player into jail and removes all other roles.
- - - - Command Parameters: - -Removes a player from jail.
- - - - Command Parameters: - -Commands Module - Kill - - Adds a command that allows players to kill them selfs and others
- - - - - - - - - - - - -| expcore.commands | -
| expcore.roles | -
| kill | -Kills yourself or another player. | -
Commands Module - Last location - - Adds a command that will return the last location of a player
- - - - - - - - - - - - -| expcore.commands | -
| expcore.common | -
| last-location | -Get the last location of a player. | -
Commands Module - Me - - Adds a command that adds * around your message in the chat
- - - - - - - - - - - - -| expcore.commands | -
| me | -Sends an action message in the chat | -
Commands Module - Protection - - Adds commands that can add and remove protection
- - - - - - - - - - - - -| utils.event | -
| utils.global | -
| expcore.roles | -
| expcore.commands | -
| expcore.common | -
| modules.control.protection | -
| modules.control.selection | -
| protect-entity | -Toggles entity protection selection | -
| protect-area | -Toggles area protection selection | -