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 | -