OVH Minecraft - Python

Introduction

In this guide, we will explore how to work with the OVH Minecraft API using the Python programming language. The OVH Minecraft API allows developers to manage and automate various tasks related to Minecraft game servers hosted on the OVH platform.

We will cover the following topics in this guide:

1. Prerequisites
2. Installation
3. Authentication
4. Server Management
   • Create a Minecraft Server
   • Start, Stop, and Restart a Server
   • Get Server Information
   • Delete a Server
5. Player Management
   • Whitelist Players
   • Ban Players
   • Kick Players
6. Configuration Management
   • Edit Server Properties
   • Set Server Icon
   • Manage Server Plugins

Let's get started!

Prerequisites

Before we begin, make sure you have the following:

• An OVH Minecraft account
• Python installed on your system
• requests library installed (pip install requests)

Installation

To interact with the OVH Minecraft API using Python, we need to install the ovh library. Run the following command to install it:

pip install ovh

Authentication

To authenticate with the OVH Minecraft API, we need to obtain the necessary credentials. Follow these steps to generate the credentials:

1. Log in to your OVH account.
2. Go to the OVH API section.
3. Click on Create a new application.
4. Fill in the required details and select Minecraft from the Application type dropdown.
5. Enable the necessary permissions for your application.
6. Click on Create this application.
7. Once created, you will be provided with Application Key, Application Secret, Consumer Key, and Endpoint URL.

Store these credentials securely, as we will need them to authenticate our Python code with the OVH Minecraft API.

# OVH Minecraft API Credentials
application_key = 'YOUR_APPLICATION_KEY'
application_secret = 'YOUR_APPLICATION_SECRET'
consumer_key = 'YOUR_CONSUMER_KEY'
endpoint = 'YOUR_ENDPOINT_URL'

Server Management

Create a Minecraft Server

To create a Minecraft server using the OVH Minecraft API, we need to send a POST request to the server creation endpoint. Use the following code snippet as an example:

import ovh

client = ovh.Client(endpoint=endpoint, application_key=application_key, application_secret=application_secret, consumer_key=consumer_key)

payload = {
    'game': 'minecraft',
    'name': 'my-minecraft-server',
    'region': 'EU',
    'flavor': 'nc-32',
    'protocol': 'mcpe'
}

response = client.post('/cloud/project/{PROJECT_ID}/instance', **payload)

Start, Stop, and Restart a Server

To start, stop, and restart a Minecraft server, we can send requests to the server control endpoints. Use the following code snippets as examples:

# Start a server
response = client.post('/cloud/project/{PROJECT_ID}/instance/{INSTANCE_ID}/start')

# Stop a server
response = client.post('/cloud/project/{PROJECT_ID}/instance/{INSTANCE_ID}/stop')

# Restart a server
response = client.post('/cloud/project/{PROJECT_ID}/instance/{INSTANCE_ID}/restart')

Get Server Information

To retrieve information about a Minecraft server, we can send a GET request to the server information endpoint. Use the following code snippet as an example:

response = client.get('/cloud/project/{PROJECT_ID}/instance/{INSTANCE_ID}')
server_info = response.json()

Delete a Server

To delete a Minecraft server, we can send a DELETE request to the server deletion endpoint. Use the following code snippet as an example:

response = client.delete('/cloud/project/{PROJECT_ID}/instance/{INSTANCE_ID}')

Player Management

Whitelist Players

To whitelist players on a Minecraft server, we can send a POST request to add players to the whitelist. Use the following code snippet as an example:

payload = {
    'whitelist': [
        'player1',
        'player2',
        'player3'
    ]
}

response = client.post('/cloud/project/{PROJECT_ID}/instance/{INSTANCE_ID}/whitelist', **payload)

Ban Players

To ban players from a Minecraft server, we can send a POST request to add players to the ban list. Use the following code snippet as an example:

payload = {
    'banlist': [
        'player1',
        'player2',
        'player3'
    ]
}

response = client.post('/cloud/project/{PROJECT_ID}/instance/{INSTANCE_ID}/banlist', **payload)

Kick Players

To kick players from a Minecraft server, we can send a POST request to kick players. Use the following code snippet as an example:

payload = {
    'players': [
        'player1',
        'player2',
        'player3'
    ]
}

response = client.post('/cloud/project/{PROJECT_ID}/instance/{INSTANCE_ID}/kick', **payload)

Configuration Management

Edit Server Properties

To edit server properties, such as the server name, game mode, difficulty, etc., we can send a POST request to update the server configuration. Use the following code snippet as an example:

payload = {
    'properties': {
        'gamemode': 'creative',
        'difficulty': 'normal',
        'max-players': 20,
        'spawn-protection': 10
    }
}

response = client.post('/cloud/project/{PROJECT_ID}/instance/{INSTANCE_ID}/update', **payload)

Set Server Icon

To set a server icon, we can send a POST request to update the server's icon image. Use the following code snippet as an example:

payload = {
    'icon': 'BASE64_ENCODED_IMAGE'
}

response = client.post('/cloud/project/{PROJECT_ID}/instance/{INSTANCE_ID}/icon', **payload)

Manage Server Plugins

To manage plugins on a Minecraft server, we can send requests to install, update, or remove plugins. Use the following code snippets as examples:

# Install a plugin
payload = {
    'pluginId': 'my-plugin',
    'url': 'https://example.com/my-plugin.jar'
}

response = client.post('/cloud/project/{PROJECT_ID}/instance/{INSTANCE_ID}/plugins', **payload)

# Update a plugin
payload = {
    'pluginId': 'my-plugin',
    'url': 'https://example.com/my-plugin-v2.jar'
}

response = client.put('/cloud/project/{PROJECT_ID}/instance/{INSTANCE_ID}/plugins/{PLUGIN_ID}', **payload)

# Remove a plugin
response = client.delete('/cloud/project/{PROJECT_ID}/instance/{INSTANCE_ID}/plugins/{PLUGIN_ID}')

These are just a few examples of what you can do with the OVH Minecraft API using Python. Refer to the OVH Minecraft API documentation for more details and available endpoints.

Remember to handle errors and exceptions appropriately in your code to ensure proper error handling and graceful fallbacks.

Happy coding!