Skip to content

Make the README a bit better #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Olika120 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Make the README a bit better #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,32 @@
# TapToDo
Source of the TapToDo plugin for PocketMine

## Introduction

TapToDo is a plugin intended for server admins that want a better way for players to interact with their server. You can make any kind of block into a TapToDo block by using a few simple commands detailed below.

## Commands

There are 2 ways to add commands onto a block:

### Nearby Block Management:
Blocks can be specified by tapping them after executing the command

| Command | Description |
|------------------|-----------------------------------------------------|
| /t add <command> | Adds a command to the specified block |
| /t del <command> | Deletes the command from the specified block |
| /t delall | Removes all commands from the specified block |
| /t name <name> | Allows you to name the block, for remote management |
| /t list | Lists all commands assigned to the specified block |

### Remote Block Management:
Blocks can be specified by inputting their name before the subcommand

| Command | Description |
|--------------------------|-----------------------------------------------------|
| /tr <name> add <command> | Adds a command to the specified block |
| /tr <name> del <command> | Deletes the command from the specified block |
| /tr <name> delall | Removes all commands from the specified block |
| /tr <name> name <name> | Allows you to name the block, for remote management |
| /tr <name> list | Lists all commands assigned to the specified block |