Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Jonathan committed Feb 13, 2017
1 parent 06e5e07 commit 6d06af6
Show file tree
Hide file tree
Showing 30 changed files with 188 additions and 89 deletions.
27 changes: 15 additions & 12 deletions docs/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Commands
[/adventure \[Player\] - Change someone's gamemode to adventure.](commands/adventure.md)<br>
[/afk \[Player\] \[Message…\] - Toggle whether a player is marked as away-from-keyboard.](commands/afk.md)<br>
[/back - Teleport back to the location you were before you teleported.](commands/back.md)<br>
[/broadcast \<Message…\> - Send a message to everyone on the server.](commands/broadcast.md)<br>
[/broadcast ?|\<Message…\> - Send a message to everyone on the server.](commands/broadcast.md)<br>
[/burn \<Player\> \[Time\] - Set people on fire.](commands/burn.md)<br>
[/clearinventory \[Player\] - Remove all items from someone's inventory.](commands/clearinventory.md)<br>
[/clearinventory ?|\[Player\] - Remove all items from someone's inventory.](commands/clearinventory.md)<br>
[/commandspy \[Player\] - Toggle a player's or your own commandspy status.](commands/commandspy.md)<br>
[/country \<Player\> - View the country where a player is from.](commands/country.md)<br>
[/createkit \<Name\> \[Cooldown\] \[Description…\] - Create a kit with the contents of your inventory.](commands/createkit.md)<br>
Expand All @@ -18,16 +18,17 @@ Commands
[/delgroupspawn \<Group\> - Delete a group spawn.](commands/delgroupspawn.md)<br>
[/delhome \<Home\> - Remove a home.](commands/delhome.md)<br>
[/deljail \<Jail\> - Remove the jail with the provided name.](commands/deljail.md)<br>
[/delnick \[Player\] - Remove a player's nickname.](commands/delnick.md)<br>
[/delnick ?|\[Player\] - Remove a player's nickname.](commands/delnick.md)<br>
[/delwarp \<Warp\> - Remove the specified warp.](commands/delwarp.md)<br>
[/firstspawn \[Player\] - Teleport someone to the new player spawn.](commands/firstspawn.md)<br>
[/fly \[Player\] - Toggle someone's fly status.](commands/fly.md)<br>
[/flyspeed \<Speed\> \[Player\] - Change a player's flyspeed. (1 by default)](commands/flyspeed.md)<br>
[/flyspeed ?|\<Speed\> \[Player\] - Change a player's flyspeed. (1 by default)](commands/flyspeed.md)<br>
[/food \[Player\] - Fill a player's food bar.](commands/food.md)<br>
[/gamemode \<Gamemode\> \[Player\] - Change a player's gamemode.](commands/gamemode.md)<br>
[/globalspawn \[Player\] - Teleport someone to the global spawn.](commands/globalspawn.md)<br>
[/god \[Player\] - Toggle your or someone else's god mode.](commands/god.md)<br>
[/groupspawn \[Player\] \[Group\] - Teleport someone to a group spawn.](commands/groupspawn.md)<br>
[/hat ?|\[Player\] - Put the item in your hand on your hat.](commands/hat.md)<br>
[/heal \[Player\] - Heal a player.](commands/heal.md)<br>
[/home \[Home\] - Teleport to your home.](commands/home.md)<br>
[/homelist - View a list of your homes.](commands/homelist.md)<br>
Expand All @@ -50,9 +51,10 @@ Commands
[/messagespy \[Player\] - Toggle a player's or your own commandspy status.](commands/messagespy.md)<br>
[/more - Set the quantity of the item in your hand to the maximum.](commands/more.md)<br>
[/mute \<Player\> \[Time\] \[Reason…\] - Mute a player, for a certain time and reason.](commands/mute.md)<br>
[/nick \<Nick\> \[Player\] - Give someone a custom name.](commands/nick.md)<br>
[/nick ?|\<Nick\> \[Player\] - Give someone a custom name.](commands/nick.md)<br>
[/night - Set the time in a certain world to night.](commands/night.md)<br>
[/personalmessage \<Player\> \<Message…\> - Send a private message to an other player.](commands/personalmessage.md)<br>
[/ping ?|\[Player\] - View a player's ping.](commands/ping.md)<br>
[/rain \[World\] - Change the weather to rain.](commands/rain.md)<br>
[/random \<Min\> \[Second\] - Generate a random number between two values.](commands/random.md)<br>
[/removekit \<Kit\> - Permanently delete a kit.](commands/removekit.md)<br>
Expand All @@ -68,28 +70,29 @@ Commands
[/setwarp \<Name\> \[Description…\] - Create a new warp with the specified name and description.](commands/setwarp.md)<br>
[/spawn \[Player\] - Teleport someone to the spawn.](commands/spawn.md)<br>
[/spectator \[Player\] - Change someone's gamemode to spectator.](commands/spectator.md)<br>
[/speed \<Speed\> \[Player\] - Change a player's flyspeed if he is flying, or else the player's walkspeed. (1 by default)](commands/speed.md)<br>
[/speed ?|\<Speed\> \[Player\] - Change a player's flyspeed if he is flying, or else the player's walkspeed. (1 by default)](commands/speed.md)<br>
[/sudo \<Player\> \<Command…\> - Force a player to chat or to use a command.
/sudo <Player> /command
/sudo <Player> message](commands/sudo.md)<br>
[/sun \[World\] - Change the weather to sun.](commands/sun.md)<br>
[/survival \[Player\] - Change someone's gamemode to survival.](commands/survival.md)<br>
[/teleport \[Player\] \<Player\> OR /teleport \[Player\] \<X\> \[Y\] \<Z\> \[\<Yaw\> \<Pitch\>\] - Teleport a player or yourself to another player or certain coordinates.](commands/teleport.md)<br>
[/teleportaccept \[Tpid\] - Accept the specified request, or the most recent one.](commands/teleportaccept.md)<br>
[/teleportall - Teleport everyone to you.](commands/teleportall.md)<br>
[/teleportall ?| - Teleport everyone to you.](commands/teleportall.md)<br>
[/teleportask \<Player\> - Ask to teleport to a player.](commands/teleportask.md)<br>
[/teleportaskallhere - Ask everyone to teleport to you.](commands/teleportaskallhere.md)<br>
[/teleportaskallhere ?| - Ask everyone to teleport to you.](commands/teleportaskallhere.md)<br>
[/teleportaskhere \<Player\> - Ask to teleport a player to you.](commands/teleportaskhere.md)<br>
[/teleportdeny \[Tpid\] - Deny the specified request, or the most recent one.](commands/teleportdeny.md)<br>
[/teleporthere \<Entities\> - Teleport someone to you.](commands/teleporthere.md)<br>
[/teleporthere ?|\<Entities\> - Teleport someone to you.](commands/teleporthere.md)<br>
[/thunder \[World\] - Change the weather to thunder.](commands/thunder.md)<br>
[/time add|set|query|night|enable|disable|day|\[Time\] - Time-related actions.](commands/time.md)<br>
[/ultimatecore gendocs|reload|clearcache|resetuser|error|modules| - The UltimateCore base command.](commands/ultimatecore.md)<br>
[/time add|set|query|night|enable|disable|day|?|\[Time\] - Time-related actions.](commands/time.md)<br>
[/ultimatecore gendocs|reload|clearcache|resetuser|error|modules|?| - The UltimateCore base command.](commands/ultimatecore.md)<br>
[/undeaf \<Player\> - Make a player no longer deaf.](commands/undeaf.md)<br>
[/unjail \<Player\> - Unjail a player.](commands/unjail.md)<br>
[/unmute \<Player\> - Unmute a player.](commands/unmute.md)<br>
[/vanish \[Player\] - Toggle whether a player is vanished.](commands/vanish.md)<br>
[/walkspeed \<Speed\> \[Player\] - Change a player's walkspeed. (1 by default)](commands/walkspeed.md)<br>
[/walkspeed ?|\<Speed\> \[Player\] - Change a player's walkspeed. (1 by default)](commands/walkspeed.md)<br>
[/warp \[Warp\] - Teleport yourself to the specified warp.](commands/warp.md)<br>
[/warplist - Get a paginated list of all warps.](commands/warplist.md)<br>
[/weather sun/rain/thunder \[World\] - Change the weather to sun, rain or thunder.](commands/weather.md)<br>
[/world setdifficulty|import|setkeepspawnloaded|teleport|sethardcore|setpvp|delete|enable|create|info|setloadonstartup|setgamemode|gamerule|disable|setworldspawn|?| - World management command.](commands/world.md)<br>
4 changes: 2 additions & 2 deletions docs/commands/broadcast.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Broadcast
====
Send messages to everyone on the server.
Send a message to everyone on the server.

Usage: /broadcast \<Message…\><br>
Usage: /broadcast ?|\<Message…\><br>
Aliases: broadcast, bc<br>
Module: [broadcast](../modules/broadcast.md)<br>

Expand Down
2 changes: 1 addition & 1 deletion docs/commands/clearinventory.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Clearinventory
====
Remove all items from someone's inventory.

Usage: /clearinventory \[Player\]<br>
Usage: /clearinventory ?|\[Player\]<br>
Aliases: clearinventory, clear, ci<br>
Module: [inventory](../modules/inventory.md)<br>

Expand Down
2 changes: 1 addition & 1 deletion docs/commands/commandspy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Commandspy
====
Toggle a player's or your own commandspy status. When commandspy is enabled you can see when other people use commands.
Toggle a player's or your own commandspy status.

Usage: /commandspy \[Player\]<br>
Aliases: commandspy, cmdspy, spycommand, spycmd<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/delnick.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Delnick
====
Remove a player's nickname.

Usage: /delnick \[Player\]<br>
Usage: /delnick ?|\[Player\]<br>
Aliases: delnick, delnickname, removenick, removenickname, resetnick, resetnickname<br>
Module: [nick](../modules/nick.md)<br>

Expand Down
2 changes: 1 addition & 1 deletion docs/commands/flyspeed.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Flyspeed
====
Change a player's flyspeed. (1 by default)

Usage: /flyspeed \<Speed\> \[Player\]<br>
Usage: /flyspeed ?|\<Speed\> \[Player\]<br>
Aliases: flyspeed, fspeed<br>
Module: [fly](../modules/fly.md)<br>

Expand Down
2 changes: 1 addition & 1 deletion docs/commands/messagespy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Messagespy
====
Toggle a player's or your own commandspy status. When commandspy is enabled you can see when other people whisper.
Toggle a player's or your own commandspy status.

Usage: /messagespy \[Player\]<br>
Aliases: messagespy, msgspy, spymessage, spymsg, whisperspy, spywhisper<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/nick.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Nick
====
Give someone a custom name.

Usage: /nick \<Nick\> \[Player\]<br>
Usage: /nick ?|\<Nick\> \[Player\]<br>
Aliases: nick, nickname<br>
Module: [nick](../modules/nick.md)<br>

Expand Down
2 changes: 1 addition & 1 deletion docs/commands/random.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Random
====
Generate a random number between two values. If the minimum is not given it is set to 1.
Generate a random number between two values.

Usage: /random \<Min\> \[Second\]<br>
Aliases: random<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/speed.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Speed
====
Change a player's flyspeed if he is flying, or else the player's walkspeed. (1 by default)

Usage: /speed \<Speed\> \[Player\]<br>
Usage: /speed ?|\<Speed\> \[Player\]<br>
Aliases: speed, generalspeed<br>
Module: [fly](../modules/fly.md)<br>

Expand Down
2 changes: 2 additions & 0 deletions docs/commands/sudo.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Sudo
====
Force a player to chat or to use a command.
/sudo <Player> /command
/sudo <Player> message

Usage: /sudo \<Player\> \<Command…\><br>
Aliases: sudo, fcommand, fcmd, fchat, forcechat, forcecmd, forcecommand<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/teleportall.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Teleportall
====
Teleport everyone to you.

Usage: /teleportall<br>
Usage: /teleportall ?|<br>
Aliases: teleportall, tpall<br>
Module: [teleport](../modules/teleport.md)<br>

Expand Down
2 changes: 1 addition & 1 deletion docs/commands/teleportaskallhere.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Teleportaskallhere
====
Ask everyone to teleport to you.

Usage: /teleportaskallhere<br>
Usage: /teleportaskallhere ?|<br>
Aliases: teleportaskallhere, tpaallhere, teleportaskall, tpaall<br>
Module: [teleport](../modules/teleport.md)<br>

Expand Down
2 changes: 1 addition & 1 deletion docs/commands/teleporthere.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Teleporthere
====
Teleport someone to you.

Usage: /teleporthere \<Entities\><br>
Usage: /teleporthere ?|\<Entities\><br>
Aliases: teleporthere, tphere<br>
Module: [teleport](../modules/teleport.md)<br>

Expand Down
24 changes: 11 additions & 13 deletions docs/commands/time.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
Time
====
/time (set/add) day/night/<ticks> - Change the time.
/time enable/disable - Enable or disable time.
/time query - View the time.
Time-related actions.

Usage: /time add|set|query|night|enable|disable|day|\[Time\]<br>
Usage: /time add|set|query|night|enable|disable|day|?|\[Time\]<br>
Aliases: time<br>
Module: [time](../modules/time.md)<br>

Expand All @@ -13,12 +11,12 @@ Basic role: nobody<br>

Permissions: <br>
* **uc.time.time.base** - Recommended role: nobody<br>Allows you to use the /time command.
* **uc.time.time.add.base** - Recommended role: nobody<br>Allows you to use the /add command.
* **uc.time.time.day.base** - Recommended role: nobody<br>Allows you to use the /day command.
* **uc.time.time.disable.base** - Recommended role: nobody<br>Allows you to use the /disable command.
* **uc.time.time.enable.base** - Recommended role: nobody<br>Allows you to use the /enable command.
* **uc.time.time.night.base** - Recommended role: nobody<br>Allows you to use the /night command.
* **uc.time.time.query.base** - Recommended role: nobody<br>Allows you to use the /query command.
* **uc.time.time.set.base** - Recommended role: nobody<br>Allows you to use the /set command.
* **uc.time.time.day.base** - Recommended role: nobody<br>Allows you to use the /day command.
* **uc.time.time.night.base** - Recommended role: nobody<br>Allows you to use the /night command.
* **uc.time.time.add.base** - Recommended role: nobody<br>Allows you to use the /time add command.
* **uc.time.time.day.base** - Recommended role: nobody<br>Allows you to use the /time day command.
* **uc.time.time.disable.base** - Recommended role: nobody<br>Allows you to use the /time disable command.
* **uc.time.time.enable.base** - Recommended role: nobody<br>Allows you to use the /time enable command.
* **uc.time.time.night.base** - Recommended role: nobody<br>Allows you to use the /time night command.
* **uc.time.time.query.base** - Recommended role: nobody<br>Allows you to use the /time query command.
* **uc.time.time.set.base** - Recommended role: nobody<br>Allows you to use the /time set command.
* **uc.time.time.day.base** - Recommended role: nobody<br>Allows you to use the /time day command.
* **uc.time.time.night.base** - Recommended role: nobody<br>Allows you to use the /time night command.
14 changes: 7 additions & 7 deletions docs/commands/ultimatecore.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Ultimatecore
====
The UltimateCore base command.

Usage: /ultimatecore gendocs|reload|clearcache|resetuser|error|modules|<br>
Usage: /ultimatecore gendocs|reload|clearcache|resetuser|error|modules|?|<br>
Aliases: ultimatecore, uc<br>
Module: [default](../modules/default.md)<br>

Expand All @@ -11,9 +11,9 @@ Basic role: owner<br>

Permissions: <br>
* **uc.default.ultimatecore.base** - Recommended role: owner<br>Allows you to use the /ultimatecore command.
* **uc.default.ultimatecore.clearcache.base** - Recommended role: nobody<br>Allows you to use the /clearcache command.
* **uc.default.ultimatecore.resetuser.base** - Recommended role: nobody<br>Allows you to use the /resetuser command.
* **uc.default.ultimatecore.modules.base** - Recommended role: nobody<br>Allows you to use the /modules command.
* **uc.default.ultimatecore.gendocs.base** - Recommended role: nobody<br>Allows you to use the /gendocs command.
* **uc.default.ultimatecore.error.base** - Recommended role: nobody<br>Allows you to use the /error command.
* **uc.default.ultimatecore.reload.base** - Recommended role: nobody<br>Allows you to use the /reload command.
* **uc.default.ultimatecore.clearcache.base** - Recommended role: nobody<br>Allows you to use the /ultimatecore clearcache command.
* **uc.default.ultimatecore.resetuser.base** - Recommended role: nobody<br>Allows you to use the /ultimatecore resetuser command.
* **uc.default.ultimatecore.modules.base** - Recommended role: nobody<br>Allows you to use the /ultimatecore modules command.
* **uc.default.ultimatecore.gendocs.base** - Recommended role: nobody<br>Allows you to use the /ultimatecore gendocs command.
* **uc.default.ultimatecore.error.base** - Recommended role: nobody<br>Allows you to use the /ultimatecore error command.
* **uc.default.ultimatecore.reload.base** - Recommended role: nobody<br>Allows you to use the /ultimatecore reload command.
2 changes: 1 addition & 1 deletion docs/commands/walkspeed.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Walkspeed
====
Change a player's walkspeed. (1 by default)

Usage: /walkspeed \<Speed\> \[Player\]<br>
Usage: /walkspeed ?|\<Speed\> \[Player\]<br>
Aliases: walkspeed, wspeed<br>
Module: [fly](../modules/fly.md)<br>

Expand Down
2 changes: 2 additions & 0 deletions docs/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Modules
[mute - Allows you to mute a player and the player won't be able to send chat, but will be able to see the chat.](modules/mute.md)<br>
[nick - Allows players to change their display name.](modules/nick.md)<br>
[personalmessage - Send private messages to other players.](modules/personalmessage.md)<br>
[playerinfo - Allows you to see information about players.](modules/playerinfo.md)<br>
[poke - Hear a configurable sound when someone says your name in chat.](modules/poke.md)<br>
[random - Generate random numbers with a simple command](modules/random.md)<br>
[serverlist - Make your server look nice in the server list.](modules/serverlist.md)<br>
Expand All @@ -43,3 +44,4 @@ Modules
[votifier - ](modules/votifier.md)<br>
[warp - Let the admin set certain locations where a player can teleport to.](modules/warp.md)<br>
[weather - Change the minecraft world's weather, or disable it.](modules/weather.md)<br>
[world - World management.](modules/world.md)<br>
3 changes: 2 additions & 1 deletion docs/modules/broadcast.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ Broadcast
Broadcast custom messages over the server.

Commands: <br>
* **[/broadcast \<Message…\>](../commands/broadcast.md)**<br>Send messages to everyone on the server.
* **[/broadcast ?|\<Message…\>](../commands/broadcast.md)**<br>Send a message to everyone on the server.

Permissions: <br>
* **uc.broadcast.broadcast.base** - Recommended role: admin<br>Allows you to use the /broadcast command.
* **uc.broadcast.broadcast.?.base** - Recommended role: nobody<br>Allows you to use the /broadcast ? command.
21 changes: 14 additions & 7 deletions docs/modules/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,21 @@ Default
The default module of ultimatecore containing the /ultimatecore command.

Commands: <br>
* **[/ultimatecore gendocs|reload|clearcache|resetuser|error|modules|](../commands/ultimatecore.md)**<br>The UltimateCore base command.
* **[/ultimatecore gendocs|reload|clearcache|resetuser|error|modules|?|](../commands/ultimatecore.md)**<br>The UltimateCore base command.

Permissions: <br>
* **uc.default.ultimatecore.base** - Recommended role: owner<br>Allows you to use the /ultimatecore command.
* **uc.default.ultimatecore.clearcache.base** - Recommended role: nobody<br>Allows you to use the /clearcache command.
* **uc.default.ultimatecore.resetuser.base** - Recommended role: nobody<br>Allows you to use the /resetuser command.
* **uc.default.ultimatecore.modules.base** - Recommended role: nobody<br>Allows you to use the /modules command.
* **uc.default.ultimatecore.gendocs.base** - Recommended role: nobody<br>Allows you to use the /gendocs command.
* **uc.default.ultimatecore.error.base** - Recommended role: nobody<br>Allows you to use the /error command.
* **uc.default.ultimatecore.reload.base** - Recommended role: nobody<br>Allows you to use the /reload command.
* **uc.default.ultimatecore.clearcache.base** - Recommended role: nobody<br>Allows you to use the /ultimatecore clearcache command.
* **uc.default.ultimatecore.resetuser.base** - Recommended role: nobody<br>Allows you to use the /ultimatecore resetuser command.
* **uc.default.ultimatecore.modules.base** - Recommended role: nobody<br>Allows you to use the /ultimatecore modules command.
* **uc.default.ultimatecore.gendocs.base** - Recommended role: nobody<br>Allows you to use the /ultimatecore gendocs command.
* **uc.default.ultimatecore.error.base** - Recommended role: nobody<br>Allows you to use the /ultimatecore error command.
* **uc.default.ultimatecore.reload.base** - Recommended role: nobody<br>Allows you to use the /ultimatecore reload command.
* **uc.default.ultimatecore.clearcache.?.base** - Recommended role: nobody<br>Allows you to use the /ultimatecore clearcache ? command.
* **uc.default.ultimatecore.resetuser.?.base** - Recommended role: nobody<br>Allows you to use the /ultimatecore resetuser ? command.
* **uc.default.ultimatecore.modules.?.base** - Recommended role: nobody<br>Allows you to use the /ultimatecore modules ? command.
* **uc.default.ultimatecore.gendocs.?.base** - Recommended role: nobody<br>Allows you to use the /ultimatecore gendocs ? command.
* **uc.default.ultimatecore.error.?.base** - Recommended role: nobody<br>Allows you to use the /ultimatecore error ? command.
* **uc.default.ultimatecore.reload.?.base** - Recommended role: nobody<br>Allows you to use the /ultimatecore reload ? command.
* **uc.default.ultimatecore.?.base** - Recommended role: nobody<br>Allows you to use the /ultimatecore ? command.
* **uc.ultimatecore.ultimatecore.base** - Recommended role: owner<br>Allows you to use the /ultimatecore command.
Loading

0 comments on commit 6d06af6

Please sign in to comment.