diff --git a/README.md b/README.md index 77b36bc..c869d94 100644 --- a/README.md +++ b/README.md @@ -11,4 +11,6 @@ CoreProtect is a blazing fast data logging and anti-griefing tool for Minecraft Contributing ------ -This project is still under development, and is not yet ready for testing or contributions. \ No newline at end of file +This project is still under development, and is not yet ready for testing or contributions. + +[![Netlify Status](https://api.netlify.com/api/v1/badges/c1d26a0f-65c5-4e4b-95d7-e08af671ab67/deploy-status)](https://app.netlify.com/sites/coreprotect/deploys) \ No newline at end of file diff --git a/docs/commands.md b/docs/commands.md index cb52ba8..ba58cb2 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -1,235 +1,268 @@ -# Commands - -You can access the commands using either `/coreprotect` or it's aliases `/core` or `/co`. - -## Command Overview - -| Command | Description | -| --- | --- | -| [help](#help) | Display a list of commands | -| [inspect](#inspect) | Toggle the inspector | -| [rollback](#rollback) | Rollback block data | -| [restore](#restore) | Restore block data | -| [lookup](#lookup) | Advanced block data lookup | -| [purge](#purge) | Delete old block data | -| [reload](#reload) | Reload the configuration file | -| [status](#status) | View the plugin status | -| [near](#near) | Alias for lookup with a radius of 5 | -| [undo](#undo) | Revert a rollback/restore | - -## Commands Detailed - -### help - -Usage: -`/co help` - -Displays the list of available commands - -Example Output: - -```text ------ CoreProtect Help ----- -/co help - Display more info for that command. -/co inspect - Turns the block inspector on or off. -/co rollback - Rollback block data. -/co restore - Restore block data. -/co lookup - Advanced block data lookup. -/co purge - Delete old block data. -/co reload - Reloads the configuration file. -/co status - Displays the plugin status. -``` - -### inspect - -Usage: -`/co inspect` - -Alias: `/co i` - -Enables the in-game inspector. Once activated, right-click (use) button on blocks to get detailed history of that specific block. Run the command again to return your controls to normal. - -### lookup - -Usage: -`/co lookup ` See: [Filter Syntax](#filter-syntax) - -Alias: `/co l` - -Search through block data using parameters from filter syntax. - -#### Pagination - -If multiple pages are returned, use the command `/co lookup ` to switch pages. -To change the number of lines displayed on a page, use the command `/co lookup :<# of lines>`. - -Example: `/co l 1:10` will return 10 lines of data, starting at the first page. - -### rollback - -Usage: -`/co rollback ` See: [Filter Syntax](#filter-syntax) - -Alias: `/co rb` - -Undo all block data which matches the filter. - -### restore - -`/co restore ` See: [Filter Syntax](#filter-syntax) - -Alias `/co rs` - -Restoring can be used to undo rollbacks. This will playback all block data which matches the filter that may have been previously rolled back. - -### purge - -`/co purge t: