https://github.com/ramide1/mcapi

Minecraft web api for interacting with Spigot server
https://github.com/ramide1/mcapi

minecraft minecraft-java minecraft-plugin minecraft-server spigot-plugin

Last synced: about 1 month ago
JSON representation

Minecraft web api for interacting with Spigot server

• Host: GitHub
• URL: https://github.com/ramide1/mcapi
• Owner: ramide1
• License: mit
• Created: 2024-04-14T15:54:46.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-08-08T22:07:59.000Z (5 months ago)
• Last Synced: 2024-08-10T00:25:18.370Z (5 months ago)
• Topics: minecraft, minecraft-java, minecraft-plugin, minecraft-server, spigot-plugin
• Language: Java
• Homepage:
• Size: 13.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# McApi

Minecraft web api for interacting with Spigot server

# Getting Started

Install the plugin on your server.

Configure the plugin by editing the config.yml file:

```yml

Config:

  port: 80

  password: password

```

# Usage

Execute commands remotely using a simple HTTP POST request. Here's an example using cURL:

```bash

curl -X POST http://serverip/command -d "command=console command" -d "password=server password"

```

# Endpoints

- command: Execute a console command

- players/count: Get online players count

- players/list: Get online players list

# Contributing

We welcome contributions from the community. If you have ideas or want to contribute, please feel free to open an issue or submit a pull request.