diff --git a/.web/.gitignore b/.web/.gitignore index 6a814c3..2d70b82 100644 --- a/.web/.gitignore +++ b/.web/.gitignore @@ -1,2 +1,6 @@ /docs/.vitepress/dist/ +/docs/.vitepress/cache/ /node_modules/ +/.yarn/ +.pnp.cjs +.pnp.loader.mjs \ No newline at end of file diff --git a/.web/docs/.vitepress/config.ts b/.web/docs/.vitepress/config.ts index f12a472..249d437 100644 --- a/.web/docs/.vitepress/config.ts +++ b/.web/docs/.vitepress/config.ts @@ -1,4 +1,4 @@ -import {defineConfig} from 'vitepress' +import {DefaultTheme, defineConfig} from 'vitepress' import {discordLink, editLink, gitHubLink, projects} from '../shared' import {additionalTitle, commitRef} from "../shared/cloudflare"; @@ -9,6 +9,14 @@ const ogImage = `${ogUrl}/og-image.png` const ogTitle = 'Minekube Connect' const ogDescription = 'The Ingress Tunnel for Minecraft Servers' +const services: DefaultTheme.SidebarItem = { + text: 'Services', items: [ + {text: 'Minekube Browser →', link: '/browser/'}, + {text: 'Minekube Connect →', link: '/guide/'}, + {text: 'Minekube Games →', link: '/games/'}, + ] +} + export default defineConfig({ title: `Minekube Connect${additionalTitle}`, description: ogDescription, @@ -89,6 +97,8 @@ export default defineConfig({ nav: [ {text: 'Quick Start', link: '/guide/quick-start'}, {text: 'Connectors', link: '/guide/connectors/', activeMatch: '^/guide/connectors/'}, + {text: 'Browser', link: '/browser/', activeMatch: '^/browser/'}, + {text: 'Games', link: '/games/', activeMatch: '^/games/'}, {text: 'Blog', link: '/blog/', activeMatch: '^/blog/'}, {text: 'Plans', link: '/plans'}, ...projects, @@ -192,6 +202,7 @@ export default defineConfig({ {text: 'Why', link: '/guide/why'}, ] }, + services // { // text: 'APIs', // items: [ @@ -202,6 +213,123 @@ export default defineConfig({ // ] // } ], + '/browser/': [ + { + text: 'Minekube Browser', + items: [ + { + text: 'Introduction', link: '/browser/', items: [ + {text: 'Platform', link: '/browser/platform'}, + {text: 'Vision', link: '/browser/vision'}, + {text: `It's about You`, link: '/browser/you'}, + ] + }, + { + text: 'FAQ', link: '/browser/faq/', items: [] + }, + ] + }, + { + text: 'Guides', items: [ + { + text: 'Launch Guide', link: '/browser/launch/', items: [ + {text: 'Launch Your Server', link: '/browser/launch/server'}, + {text: 'Launch Your Game', link: '/browser/launch/game'}, + ] + }, + { + text: 'Community Engagement', link: '/browser/engage/', items: [ + {text: 'Best Practices', link: '/browser/engage/tips'}, + {text: 'Update Launches', link: '/browser/engage/updates'}, + {text: 'Event Management', link: '/browser/engage/events'}, + ] + }, + ] + }, + { + text: 'API', items: [ + {text: 'Overview', link: '/browser/api/'}, + {text: 'Authentication', link: '/browser/api/auth'}, + {text: 'Versioning', link: '/browser/api/versions'}, + {text: 'Endpoints', link: '/browser/api/endpoints'}, + {text: 'Rate Limits', link: '/browser/api/ratelimits'}, + {text: 'SDK and Resources', link: '/browser/api/developers'}, + ] + }, + services, + ], + '/games/': [ + { + text: 'Minekube Games', + items: [ + {text: 'Introduction', link: '/games/'}, + {text: 'Vision', link: '/games/vision'}, + ] + }, + { + text: 'Hosting Options', items: [ + {text: 'Overview', link: '/games/hosting/'}, + {text: 'Managed Providers', link: '/games/hosting/provider'}, + { + text: 'Kubernetes', link: '/games/hosting/kubernetes/', items: [ + {text: 'Levels Overview', link: '/games/hosting/kubernetes/levels'}, + {text: 'Level 4', link: '/games/hosting/kubernetes/level-4'}, + {text: 'Level 3', link: '/games/hosting/kubernetes/level-3'}, + {text: 'Level 2', link: '/games/hosting/kubernetes/level-2'}, + {text: 'Level 1', link: '/games/hosting/kubernetes/level-1'}, + ] + }, + {text: 'Docker', link: '/games/hosting/container'}, + ] + }, + { + text: 'Guides', items: [ + {text: 'Developing Games →', link: '/games/developers/'}, + {text: 'Becoming Provider →', link: '/games/providers/'}, + {text: 'Creating Game Servers →', link: '/games/servers/create'}, + ] + }, + services, + ], + '/games/developers/': [ + { + text: 'Minekube Games Developers', + items: [ + {text: 'Overview', link: '/games/developers/'}, + {text: 'The Three Ways', link: '/games/developers/the-three-ways'}, + ] + }, + { + text: 'Continuous Delivery', items: [ + {text: 'Packaging Games', link: '/games/developers/cd/packaging'}, + {text: 'Dockerfiles', link: '/games/developers/cd/dockerfiles'}, + {text: 'GitHub Action Templates', link: '/games/developers/cd/github-actions'}, + ] + }, + {text: '← Back', link: '/games/'}, + ], + '/games/providers/': [ + { + text: 'Minekube Games Providers', + items: [ + {text: 'Overview', link: '/games/providers/'}, + {text: 'Start Selling', link: '/games/providers/selling'}, + {text: 'Payouts', link: '/games/providers/payouts'}, + ] + }, + {text: '← Back', link: '/games/'}, + ], + '/games/servers/': [ + { + text: 'Minekube Games Servers', + items: [ + {text: 'Server Owners', link: '/games/servers/'}, + {text: 'Creating a Game Server', link: '/games/servers/create'}, + {text: 'Players & Friends', link: '/games/servers/players'}, + ] + }, + {text: '← Back', link: '/games/'}, + ], } } }) diff --git a/.web/docs/browser/api/auth.md b/.web/docs/browser/api/auth.md new file mode 100644 index 0000000..ef0adf8 --- /dev/null +++ b/.web/docs/browser/api/auth.md @@ -0,0 +1,42 @@ +# Minekube Browser - API Authentication + +## Overview +Authentication in the Minekube Browser API is handled through API keys. This section explains how to obtain and use your API keys to access the API securely. + +## Generating API Keys +1. **Login to Dashboard:** Access the [Minekube Dashboard](https://dashboard.minekube.com) with your user credentials. +2. **Navigate to API Section:** Locate the API management section. +3. **Create New Key:** Follow the prompts to generate a new API key. +4. **Set Permissions:** Assign the necessary permissions based on your application needs. + +## Using API Keys +- **Include in Headers:** Always include your API key in the request headers: + ```http + Authorization: Bearer + +### Endpoint Protection +- **Unauthorized Access:** All protected endpoints will return a `401 Unauthorized` response if a valid API key is not included in the request headers. + +## Rate Limiting +- **Purpose:** To prevent abuse and ensure fair usage, API requests are rate-limited. View specific rate limit details in the [Rate Limits](ratelimits.md) section. +- **Limits:** Rate limits are defined by the number of requests per minute, varying by API key. + +## Security Best Practices: +::: tip + +**Ensure secure storage of your API keys to prevent unwanted abuse. View our [Security Guide](../../guide/protections.html) for more info** +::: +### 1. Key Rotation +- **Security Recommendation:** Periodic rotation of API keys is advised to maintain security. +- **Regeneration:** Keys can be regenerated through the dashboard as needed. + +### 2. IP Whitelisting +- **Added Security:** API keys can be associated with specific IP addresses or ranges, restricting access to whitelisted IPs only. + +### 3. Fine Tuned Access +- **Access Control:** API keys are assigned different permission levels to control access to various endpoints or features within your [Minekube Organization](../../guide/quick-start.md). + +## Next Steps +- **API Versioning:** Detailed documentation on versioning for proper use of API keys is available in the [Versioning](./versions.md) section. + +- **API Endpoints:** View available endpoints and example responses in [Endpoints](./endpoints.md) section. diff --git a/.web/docs/browser/api/developers.md b/.web/docs/browser/api/developers.md new file mode 100644 index 0000000..fa5c545 --- /dev/null +++ b/.web/docs/browser/api/developers.md @@ -0,0 +1,16 @@ +# Minekube Browser - SDK and Resources + +## Overview +We provide SDKs and additional resources to facilitate easy integration of our API into your applications. + +## SDK Downloads +Download our SDKs tailored for different programming environments: + +- [Java SDK](/browser/api/developers/java) + +## Integration Examples +Example using the Java SDK to access server listings: + +```java +MinekubeAPI api = new MinekubeAPI(""); +ServerList servers = api.getServers(); diff --git a/.web/docs/browser/api/endpoints.md b/.web/docs/browser/api/endpoints.md new file mode 100644 index 0000000..9c5eb04 --- /dev/null +++ b/.web/docs/browser/api/endpoints.md @@ -0,0 +1,49 @@ +# Brower API Endpoints + +The Minekube Browser API provides a range of endpoints to interact with the platform: + +## Server Listing + +### `GET /servers` +- **Description:** Retrieve a list of all public servers. + +### `GET /servers/{id}` +- **Description:** Get details of a specific server by its ID. + +## User Authentication + +### `POST /auth/login` +- **Description:** Authenticate a user and retrieve an access token. + +### `GET /auth/me` +- **Description:** Get the currently authenticated user's details. + +### `PUT /auth/me` +- **Description:** Update the currently authenticated user's details. + +## Server Management + +### `GET /my-servers` +- **Description:** Retrieve a list of servers owned by the authenticated user. + +### `GET /my-servers/{id}` +- **Description:** Get details of a specific server owned by the authenticated user. + +### `PUT /my-servers/{id}` +- **Description:** Update the details of a specific server owned by the authenticated user. + +## Player Statistics + +### `GET /stats/players` +- **Description:** Retrieve overall player statistics, including total players, online players, and unique players. + +### `GET /stats/players/top` +- **Description:** Get a list of the top servers by player count. + +## Error Responses + +- **400 Bad Request:** Invalid request format or missing parameters. +- **401 Unauthorized:** Authentication failed or invalid API key. +- **403 Forbidden:** Access forbidden due to insufficient permissions. +- **404 Not Found:** Requested resource not found. +- **500 Internal Server Error:** An unexpected server error occurred. diff --git a/.web/docs/browser/api/index.md b/.web/docs/browser/api/index.md new file mode 100644 index 0000000..cae8621 --- /dev/null +++ b/.web/docs/browser/api/index.md @@ -0,0 +1,61 @@ +# Minekube Browser - API Documentation + +Welcome to the Minekube Browser API documentation. This guide provides all the necessary details to integrate with our API, focusing on server listings initially, with plans to expand to games, plugins, and mods. + +**Table of Contents** + +[[TOC]] + +## Authentication + +Secure access to the API is controlled through API keys and other authentication mechanisms. Here, you'll find how to obtain and manage your API keys, including: + +- **Generating API Keys:** Step-by-step guide to generate your unique API keys through the Minekube Browser dashboard. +- **Using API Keys:** How to include your API key in API requests to authenticate. +- **Security Best Practices:** Recommendations for securing your API keys. + +[Explore Authentication Details](/browser/api/auth) + +## Versioning + +To maintain stability and backward compatibility, our API implements a versioning system. This section covers: + +- **Version Formats:** Explanation of our semantic versioning format. +- **Handling Versions:** How to specify API versions in your requests. +- **Deprecation and Migration:** Guidelines on deprecated features and migrating to newer API versions. + +[Learn More About Versioning](/browser/api/versions) + +## Endpoints + +This section describes all the available API endpoints, their functions, and how to use them. Highlights include: + +- **Server Listing Endpoints:** Access information about servers, including details, listings, and management functions. +- **User and Authentication Endpoints:** How to manage user authentication and user-specific data. + +[Detailed Endpoint Information](/browser/api/endpoints) + +## Rate Limits + +Understanding the rate limits is crucial to ensure fair use and system stability. This section provides: + +- **Rate Limit Rules:** Specific limits on the number of requests that can be made to the API. +- **Best Practices:** Tips on how to handle and respond to rate limit conditions. + +[Check Our Rate Limit Policies](/browser/api/ratelimits) + +## SDK and Resources + +For developers looking to integrate quickly, we offer SDKs and other resources. This section includes: + +- **SDK Downloads:** Links to our official SDKs for various programming environments. +- **Integration Examples:** Practical examples showing how to use the API in common scenarios. +- **Developer Support:** Information on how to get help if you encounter issues or have questions. + +[Access SDK and Developer Resources](/browser/api/developers) + + +## Support +If you have any questions or issues please join our [Discord](https://minekube.com/discord). +The team and community is always happy to help you out. + diff --git a/.web/docs/browser/api/ratelimits.md b/.web/docs/browser/api/ratelimits.md new file mode 100644 index 0000000..e69de29 diff --git a/.web/docs/browser/api/versions.md b/.web/docs/browser/api/versions.md new file mode 100644 index 0000000..052dd87 --- /dev/null +++ b/.web/docs/browser/api/versions.md @@ -0,0 +1,38 @@ +# Minekube Browser - API Versioning + +## Overview +To ensure backward compatibility and smooth updates, the Minekube Browser API follows a clear versioning system. + +## Version Numbering +API versions are indicated by a semantic version number, e.g., `v1`, `v2`. This number is included in the base URL of each API endpoint. + +## Version Stability +- **Major Updates:** Transitioning from `v1` to `v2` may introduce breaking changes. +- **Minor Updates:** Upgrades such as `v1.0` to `v1.1` will remain backward-compatible. + +## Deprecation Policy +Deprecated endpoints or features will be clearly marked in the documentation, including the expected removal date. + +## Version Migration +When a new major version is released, a migration path will be provided to help users transition smoothly to the new version. + +## Version Header +API requests can include an optional `Accept-Version` header to specify the desired API version. If not provided, the latest stable version will be used. + +## Versioning in Responses +API responses may include an `API-Version` header, indicating the version used to process the request. + +## Version-Specific Documentation +The API documentation will provide separate sections for each major version, outlining any changes or additions. + +## Release Notes +Release notes will be provided for each API version, detailing any changes, improvements, or fixes. + +## Sunset Policy +Deprecated versions will continue to be supported for a defined period, after which they may be sunset. Advance notice will be provided before sunsetting a version. + +## Client Libraries +Official client libraries will be updated to support new API versions, and older versions will be maintained for a reasonable period. + +## Version Negotiation +The API may support version negotiation in the future, allowing clients to specify their preferred version and receive a response in that version. diff --git a/.web/docs/browser/engage/events.md b/.web/docs/browser/engage/events.md new file mode 100644 index 0000000..e69de29 diff --git a/.web/docs/browser/engage/index.md b/.web/docs/browser/engage/index.md new file mode 100644 index 0000000..e69de29 diff --git a/.web/docs/browser/engage/tips.md b/.web/docs/browser/engage/tips.md new file mode 100644 index 0000000..e69de29 diff --git a/.web/docs/browser/engage/updates.md b/.web/docs/browser/engage/updates.md new file mode 100644 index 0000000..e69de29 diff --git a/.web/docs/browser/faq/index.md b/.web/docs/browser/faq/index.md new file mode 100644 index 0000000..7ce498d --- /dev/null +++ b/.web/docs/browser/faq/index.md @@ -0,0 +1,27 @@ +# Minekube Browser FAQs + +Welcome to the FAQ for Minekube Browser. Here you will find answers to common questions about the platform, its features, and how you can get involved in the community. + +## What is the Minekube Browser? + +>The Minekube Browser is a revolutionary Minecraft server list and marketplace, offering a comprehensive platform for players, developers, and hosting providers. It goes beyond a simple server list by providing tools and services for building, listing, and launching Minecraft games. + +## How is Minekube Browser different from other server lists? + +> Minekube Browser is more than just a directory of servers. It offers a launchpad for server experiences, providing robust infrastructure services like Minekube Games for server management and Minekube Connect for simplified connectivity. It also focuses on community engagement and offers features to facilitate collaboration and content discovery. + +## Who is Minekube Browser for? + +> Minekube Browser caters to a wide range of the Minecraft community, including players seeking new adventures, developers crafting game worlds, and hosting providers scaling their services. Our platform is designed to be accessible and beneficial to all segments of the Minecraft community. + +## What benefits does Minekube Browser offer to players? + +> Players can discover an extensive range of Minecraft games and experiences, all in one place. Minekube Browser offers a curated selection of servers, ensuring a high-quality and diverse gaming experience. Players can also connect with other community members, participate in events, and provide feedback to shape the future of the platform. + +## How can developers benefit from Minekube Browser? + +> Developers can leverage the Minekube Browser platform to showcase their Minecraft creations, gain exposure, and build a dedicated customer base. We provide tools and services to simplify server management, connectivity, and community engagement, allowing developers to focus on crafting immersive games. + +## How can I contribute to the Minekube Browser community? + +> We encourage active participation and feedback from the community. Join our [Discord](https://minekube.com/discord) server to connect with other players, developers, and Minekube team members. You can share your ideas, provide feedback, report issues, and contribute to the overall growth and improvement of the Minekube Browser platform. \ No newline at end of file diff --git a/.web/docs/browser/index.md b/.web/docs/browser/index.md new file mode 100644 index 0000000..d57d848 --- /dev/null +++ b/.web/docs/browser/index.md @@ -0,0 +1,22 @@ +# Minekube Browser Documentation POC + +::: warning +The Minekube Browser is currently in its developmental phase. We invite you to join our [Discord](https://minekube.com/discord) community and contribute by sharing your valuable feedback! +::: + +## Introduction + +Whether you're a player seeking adventure, a developer crafting game worlds, or a hosting provider scaling your services, you've arrived at the starting point of endless possibilities. + +The Minekube Browser is more than a server list; it's a comprehensive marketplace for Minecraft games, a launchpad for server experiences, and a hub for community-driven development. It represents a paradigm shift in Minecraft server discovery, offering tools and platforms for users to build, list, and launch Minecraft games, all underpinned by Minekube's robust distributed infrastructure services like Minekube Games for server management and Minekube Connect for simplified connectivity. + +Our documentation is designed to be accessible and informative for a public audience, players, developers and providers, focusing on the practicalities and benefits of our platform and delving into the integration details for power users. As we walk you through the Minekube Browser, you'll understand how it caters to the needs of various stakeholders in the Minecraft ecosystem. + + +## Spread the word +Join us as we explore the features, vision, and community that make Minekube Browser a beacon of innovation in the Minecraft universe. We invite you to be an active participant in this journey, to collaborate, contribute, and most importantly, to enjoy the experience that the Minekube Browser offers. + +## Getting Started +Welcome aboard the new chapter of Minecraft server exploration and game building — Welcome to the Minekube Platform. + +To get started, check out our [Quicklaunch Guides](./launch/) and [FAQ](./faq/). \ No newline at end of file diff --git a/.web/docs/browser/launch/game.md b/.web/docs/browser/launch/game.md new file mode 100644 index 0000000..559a944 --- /dev/null +++ b/.web/docs/browser/launch/game.md @@ -0,0 +1,56 @@ +# Launching a Game on Minekube + +Welcome to the world of Minekube Games, where your creativity meets our technology to bring unparalleled Minecraft experiences to life. Launching your game on Minekube means entering a partnership where you can focus on what you do best — designing and developing your game. Leave the logistics of distribution, server hosting, and player management to us. Our platform is engineered to take the weight of technical complexities off your shoulders, providing a streamlined path from development to launch. + +## Why Launch with Minekube? + +- **Simplified Distribution:** We handle the intricacies of distributing your game, so it reaches players across the globe without you needing to worry about server uptime or bandwidth. +- **Managed Hosting:** Your game will be hosted on our robust partner providers infrastructure, ensuring that players have a smooth and consistent experience without any extra effort on your part. +- **Community Focus:** Engage with a ready-made community of Minecraft enthusiasts. We provide the tools for feedback, support, and interaction to help your game thrive. + +By choosing Minekube as your launchpad, you're not just releasing a game; you're igniting an adventure that we support every step of the way. Now, let's dive into the process of launching your game and making your mark in the Minecraft universe. + +## Step 1: Develop Your Game + +Before you launch, ensure your game is ready for the spotlight: + +- **Containerize Your Game:** Package your game into a Docker container, making it compatible with the Minekube Games platform for easy deployment. +- **Test Thoroughly:** Run tests to ensure stability and compatibility across different Minecraft versions to increase accessibility for players. + +## Step 2: Prepare Your Launch Materials + +Create a compelling package to attract players: + +- **Compelling Description:** Write a clear and engaging description of your game, outlining unique features and gameplay elements. +- **Visuals and Media:** Gather high-quality images, videos, and any other media that best showcase your game and what players can expect. +- **Pricing Strategy:** Decide if your game will be free or paid. If paid, set a fair price point and prepare in-game screenshots for the Minekube Browser storefront. + +## Step 3: Submit Your Game for Review + +Get your game on the platform: + +- **Submission:** Submit your game through the Minekube Developer Portal, ensuring all required materials and information are included. +- **Review Process:** Minekube will review your submission to ensure it meets community standards and technical specifications. + +## Step 4: Schedule Your Launch + +Plan for the big day: + +- **Launch Date:** Once approved, select a launch date that fits your schedule and allows for maximum visibility. +- **Promotion:** Utilize Minekube's promotional tools to build anticipation and inform potential players of your upcoming launch. Players can wishlist your game to receive notifications upon release. + +## Step 5: Engage with the Community + +Interact and grow your player base: + +- **Feedback Channels:** Set up ways to receive player feedback, such as Discord forums or direct contact methods. +- **Community Engagement:** Actively participate in community discussions to hype up your launch and address any questions or feedback. + +## Step 6: Post-Launch Support and Updates + +Keep the momentum going: + +- **Monitor Performance:** Use Minekube's analytics tools to track how your game is performing in terms of player numbers and server instances. +- **Iterate Based on Feedback:** Update your game based on community feedback and data insights to improve player retention and satisfaction. + +By following these steps, you can successfully launch your game on Minekube, reaching a global audience of Minecraft players and server owners looking for new adventures. Remember, a successful launch is just the beginning. Ongoing engagement and support are key to maintaining and growing your game's player base. \ No newline at end of file diff --git a/.web/docs/browser/launch/index.md b/.web/docs/browser/launch/index.md new file mode 100644 index 0000000..63b618e --- /dev/null +++ b/.web/docs/browser/launch/index.md @@ -0,0 +1,44 @@ +# Launching on Minekube Browser + +Welcome to the definitive guide for launching on the Minekube Browser, the platform that champions innovation and community within the Minecraft universe. This documentation will walk you through the journey of launching your game or server, helping you to capture the attention and imagination of a global audience of Minecraft enthusiasts. + +## Understanding Launches on Minekube Browser + +On Minekube Browser, launching is about more than just revealing your game or server to the world—it's about creating a moment. A successful launch combines preparation, community interaction, and strategic marketing to make a lasting impact. + +### The Launch Types: + +- **Game Launch:** Introduce your polished game to the community, ready for players to download, enjoy, and share. +- **Server Launch:** Publicize your server, inviting players to join and partake in the unique experience you've crafted. + +## The Launch Lifecycle + +Inspired by the proven approach of Product Hunt, the lifecycle of a launch on Minekube Browser is a dynamic process: + +1. **Preparation:** Set up your launch page with compelling media, a captivating description, and all the details players need. +2. **Community Building:** Engage with the Minekube community. Connect with players and gather support even before your launch goes live. +3. **Launch Timing:** Choose the perfect time for your launch. While any day can be your launch day, consider aiming for periods of high activity to maximize visibility. +4. **Promotion:** Amplify your launch through your networks. Reach out to your followers, email subscribers, and social media to drive attention and traffic. +5. **Active Engagement:** On launch day, be present to interact with the community. Respond to feedback, answer questions, and foster a conversation around your launch. + +For detailed steps and best practices, visit our [Launching a Game](./game) or [Launching a Server](./server) documentation. + +## Why Launch with Minekube Browser? + +- **Dedicated Audience:** Direct access to a community of avid Minecraft players looking for their next favorite game or server. +- **Robust Platform:** Built on a solid foundation, Minekube Browser ensures that your launch is supported by a seamless and scalable infrastructure. +- **Comprehensive Tools:** From analytics to community feedback, leverage a suite of tools designed to support and enhance your launch. + +## Your Launch Day + +When the big day arrives, it's all about momentum. Encourage your existing audience to visit your launch page, upvote, and leave feedback. The more engagement your launch receives, the more it will be noticed by others in the Minekube community. + +## Post-Launch: Sustaining the Hype + +The end of launch day isn't the finish line. Continue to engage with the community, roll out updates, and use analytics to inform your growth strategy. Your launch is just the beginning of your journey on Minekube Browser. + +## Ready, Set, Launch! + +Now that you're equipped with the knowledge and tools for a successful launch, it's time to put your plan into action. Prepare to showcase your game or server to the world, and let's make your launch on Minekube Browser a resounding success. + +Remember, a successful launch blends careful planning, exceptional content, and a vibrant community presence. Whether you're introducing a new game or inviting players to your server, Minekube Browser is where your creations take center stage. diff --git a/.web/docs/browser/launch/server.md b/.web/docs/browser/launch/server.md new file mode 100644 index 0000000..ca74197 --- /dev/null +++ b/.web/docs/browser/launch/server.md @@ -0,0 +1,38 @@ +# Launching a Server on Minekube + +Taking your game server public is an exciting opportunity to grow your community and share the Minecraft experience you've crafted. This guide is designed to help you launch your server on Minekube, offering it to players worldwide. + +## Preparation for Launch + +**1. Have a Game Server Ready:** +Before launching, you need to have an active game server. If you haven't set one up yet, please refer to our [Creating a Game Server](../../games/servers/create) documentation. + +**2. Ensure Server Readiness:** +Make sure your server is fully configured, tested, and ready to handle an influx of new players. This includes optimizing performance and ensuring all gameplay elements are functioning correctly. + +## Launching Your Server + +**3. Define Your Server Listing:** +Craft an engaging description of your server that highlights its unique features and what makes it special. Include high-quality images or videos that showcase the server environment. + +**4. Set the Server Visibility:** +Decide whether your server will be publicly listed for anyone to join or if it will require an application or an invitation to participate. + +**5. Choose the Right Time:** +Timing can be everything. Select a launch date and time that maximizes potential player availability and interest. + +## Post-Launch + +**6. Monitor and Engage:** +After your server goes live, monitor its performance and player feedback. Engage with the community to encourage growth and retention. + +**7. Update and Evolve:** +Regularly update your server with fresh content, bug fixes, and enhancements based on player input. + +## Conclusion + +Launching your server on Minekube is not just about going live — it's about starting a journey with players who will shape your server's future. Embrace the adventure, support your community, and see where the world of Minecraft can take you. + +--- + +*Note: Launching a server is a significant step. If you're new to server management or looking to trial run your setup, consider creating a private server first. This allows you to fine-tune the experience before sharing it with the public. You can always transition to a public server when you're ready.* \ No newline at end of file diff --git a/.web/docs/browser/platform.md b/.web/docs/browser/platform.md new file mode 100644 index 0000000..ec24825 --- /dev/null +++ b/.web/docs/browser/platform.md @@ -0,0 +1,19 @@ +# Minekube Browser: A Comprehensive Platform + +The Minekube Browser transcends the traditional boundaries of Minecraft server lists. It's a vibrant marketplace for developers and entrepreneurs to share their Minecraft creations and for players to embark on new gaming adventures. By connecting players, developers, and hosting providers on a single platform, Minekube Browser facilitates a seamless transition from game selection to server launch. + +## Marketplace for Minecraft Games and Server Experiences + +- **For Developers:** Showcase your Minecraft games and mods. Whether your creations are free or monetized, Minekube Browser is the place to be discovered. +- **For Players:** With a few clicks, journey into new worlds. Choose from a curated selection of games, find a hosting provider, and start your adventure. +- **For Hosting Providers:** Display your services to a targeted audience. Benefit from the integration with Minekube Games to offer a superior hosting experience. + +## Integration with Minekube Ecosystem + +Minekube Browser is integrated with Minekube's broader suite of tools and services, ensuring a cohesive user experience. + +- **Minekube Connect:** Our networking solution simplifies connectivity, offering public, DDoS-protected endpoints, making the multiplayer experience as smooth as single-player. +- **Minekube Games:** An administrative dashboard allowing server management with ease, tailored for both server admins and players to streamline their gaming experience. + +Through Minekube Browser, we're not just connecting people to games; we're connecting them to an experience that's enriched by the community and supported by robust technology. It's here that the creativity of the Minecraft community truly comes to life, supported by an infrastructure that is primed for the next generation of cloud gaming experiences. + diff --git a/.web/docs/browser/vision.md b/.web/docs/browser/vision.md new file mode 100644 index 0000000..d1853e6 --- /dev/null +++ b/.web/docs/browser/vision.md @@ -0,0 +1,33 @@ +# Vision of Minekube Browser + +The Minekube Browser is built upon a vision to innovate and reshape the Minecraft server and game discovery process. Our goal is to create a more inclusive, engaging, and balanced platform that benefits all members of the Minecraft community. + +## Democratizing Server and Game Discovery + +- **Equality in Visibility:** We implement a discovery model where new and smaller servers get as much chance to be featured as the established giants, inspired by the refreshing approach of Product Hunt's daily listings. +- **Community at the Core:** The platform is designed to be a community hub where interactions, discussions, and feedback are not just welcomed, but integral to the experience. +- **Integrated Experience:** Leveraging the existing Minekube infrastructure, the Browser ensures a fluid experience for server owners and game developers to list, manage, and promote their offerings. + +## Encouraging Quality Through Community Interaction + +- **Rewarding Innovation:** We encourage server owners and game developers to raise the bar, offering their best through community feedback and visibility. +- **Recognition for Excellence:** Servers and games that resonate with players and garner community support will enjoy heightened visibility and recognition. + +The Minekube Browser is not only a tool but a statement — a commitment to the ongoing growth and evolution of the Minecraft community. It's a space where anyone with a passion for Minecraft can find their niche, build an audience, and contribute to the rich tapestry that is the Minecraft gaming world. + +## The Product Hunt Inspiration + +The Minekube Browser draws significant inspiration from Product Hunt, a platform known for its innovative approach to product discovery. Applying these principles, we aim to create a similar buzz and excitement around Minecraft server and game launches. + +### A New Launchpad for Minecraft Servers and Games + +- **Daily Features:** Just as Product Hunt features new products daily, Minekube Browser introduces daily server and game launches, providing fresh content and discovery opportunities each day. +- **Empowered by Community Votes:** The community's voice is powerful; players can upvote and review servers and games, propelling the best to prominence and offering constructive feedback for improvement. +- **Collections Curated by Interests:** Players can navigate through custom lists like "Thrilling Adventure Servers" or "Most Innovative Minigames," making it easier to find servers that cater to their specific tastes. + +### Transparent Metrics and Feedback + +- **Insightful Statistics:** We provide server owners and game developers with valuable metrics such as playtime and user engagement, offering a clear picture of their audience's behavior and preferences. +- **Community-Driven Growth:** The visibility of servers and games on Minekube Browser is determined by community interaction, ensuring that quality and player satisfaction drive success. + +Incorporating the spirit of Product Hunt into Minekube Browser, we create a dynamic ecosystem where each day brings the potential for discovery and each server or game can have its moment in the spotlight. \ No newline at end of file diff --git a/.web/docs/browser/you.md b/.web/docs/browser/you.md new file mode 100644 index 0000000..96b8365 --- /dev/null +++ b/.web/docs/browser/you.md @@ -0,0 +1,33 @@ +# It's About You 🫵 + +The Minekube Browser is more than a platform; it's an enabler for your Minecraft ambitions. Whether you're creating game experiences, offering hosting services, or looking to play the latest and greatest in the Minecraft world, we've got the infrastructure, the community, and the support you need to succeed. + +[[TOC]] + +## Players: Embark on Your Next Adventure + +- **Explore:** A vast array of servers and games await your discovery. Find your next Minecraft obsession with ease and dive in. +- **Engage:** Your voice matters. Review, discuss, and vote for the servers you love. Help shape the community and the future of Minecraft gaming. +- **Launch:** Select a game, pick a hosting provider, and launch into play within moments. We've streamlined the process so you can focus on what you love - playing. + +## Game Developers: Power Your Creations + +- **Deploy with Ease:** Push Docker images to our platform and watch as Minekube Connect auto-deploys and connects your game to a global audience. +- **Robust Infrastructure:** Benefit from built-in Minekube Connect features, including DDoS protection and a public Anycast IP, ensuring your game is always accessible and secure. +- **Community Engagement:** We've streamlined the browsing and playing experience, making it easy for players to discover, enjoy, and rate your games. +- **Custom Deployment:** Choose your own open-source runner and tailor your deployment strategies to suit your game's unique requirements. + +## Providers: Monetize Your Hardware with Minekube Games + +As a hardware provider, you have the power to fuel countless Minecraft adventures. Minekube Games is here to bridge the gap between your compute resources and a thriving marketplace hungry for quality gaming experiences. + +- **Customer Connection:** We handle the customer acquisition, bringing a steady stream of eager players directly to your machines. +- **Plug into Our Platform:** Connect your nodes to the Minekube Games Platform easily. We manage the complex parts, including interfaces, billing, and payouts. +- **Access to a Wealth of Games:** Tap into the vast collection of games published by our vibrant community. Your customers can pick and choose these games through a managed web UI, enhancing their hosting experience. +- **Hassle-Free Payments:** Customers pay you directly through Minekube's Stripe Connect integration, ensuring secure and prompt transactions. +- **Small Commission, Big Benefits:** We only take a modest platform commission, leaving the lion's share of earnings to you. This fee goes back into providing and maintaining a platform that's always growing, always improving. +- **Continuous Platform Growth:** By partnering with us, you benefit from a platform that's continuously updated, expanded, and enriched with new features and games. + +With Minekube Games, you're not just renting out hardware; you're stepping into a partnership that promises growth, convenience, and a competitive edge in the Minecraft hosting market. Let us take care of the details while you focus on what you do best — providing the raw power for Minecraft servers to thrive. + +Minekube Browser is the bridge between your hosting services and our enthusiastic community of players and developers. Together, we create a marketplace that not only meets the demands of the Minecraft world but actively contributes to its growth. Join us, and let's innovate the future of Minecraft hosting, one server at a time. \ No newline at end of file diff --git a/.web/docs/games/developers/cd/Dockerfile.example b/.web/docs/games/developers/cd/Dockerfile.example new file mode 100644 index 0000000..c35f1b5 --- /dev/null +++ b/.web/docs/games/developers/cd/Dockerfile.example @@ -0,0 +1 @@ +FROM scratch diff --git a/.web/docs/games/developers/cd/dockerfiles.md b/.web/docs/games/developers/cd/dockerfiles.md new file mode 100644 index 0000000..8b05d33 --- /dev/null +++ b/.web/docs/games/developers/cd/dockerfiles.md @@ -0,0 +1,5 @@ +# TBD + +```dockerfile + +``` \ No newline at end of file diff --git a/.web/docs/games/developers/cd/github-action.example.yaml b/.web/docs/games/developers/cd/github-action.example.yaml new file mode 100644 index 0000000..0f8152f --- /dev/null +++ b/.web/docs/games/developers/cd/github-action.example.yaml @@ -0,0 +1,10 @@ +name: Build and Release to Minekube +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: diff --git a/.web/docs/games/developers/cd/github-actions.md b/.web/docs/games/developers/cd/github-actions.md new file mode 100644 index 0000000..c24ab8b --- /dev/null +++ b/.web/docs/games/developers/cd/github-actions.md @@ -0,0 +1,5 @@ +# TBD + +```yaml + +``` \ No newline at end of file diff --git a/.web/docs/games/developers/cd/packaging.md b/.web/docs/games/developers/cd/packaging.md new file mode 100644 index 0000000..eb98ab6 --- /dev/null +++ b/.web/docs/games/developers/cd/packaging.md @@ -0,0 +1,38 @@ +# Packaging your Games + +Packaging your game for distribution is a crucial step in reaching a wider audience and ensuring a seamless experience for players. By following best practices and leveraging the tools available in the Minekube Games platform, you can create a Game that is easy to deploy, manage, and enjoy. + +This guide provides an overview of the packaging process, including the key components of a game package, the benefits of packaging your game, and how to prepare your game for distribution on Minekube Games. + +[[TOC]] + +## Packaging Components + +A game package for Minekube Games typically includes the following components: + +- **Compiled Game Code**: This is the core of your game, written in your chosen programming language. It includes all the logic, mechanics, and assets that make up your game. +- **Configuration Files**: These files are used to configure the game's settings and behavior. They can include settings for the game itself, as well as for any dependencies or services your game uses. +- **Documentation**: This includes any marketing content, instructions or information needed to install, run, and play your game. It can also include information about the game's development and any known issues or limitations. By default, when launching and updating your game on the Minekube Browser your `README.md` file will be used as the game's description landing page. +- **License and Credits**: These files detail the legal information about your game, such as its license and any credits for assets or code used in the game. To protect your game's code further, you can use obfuscation tools to make it harder for others to reverse-engineer your source code. + +## Benefits of Packaging + +Packaging your game for distribution on Minekube Games has several benefits: + +- **Ease of Distribution**: A well-packaged game is easier to distribute and install. Players can simply download the package and follow the included instructions to start playing. +- **Version Control**: Packaging allows you to create distinct versions of your game. This makes it easier to manage updates and patches, and allows players to choose which version of the game they want to play. +- **Quality Assurance**: By packaging your game, you can ensure that all necessary components are included and that the game functions as expected. This helps to prevent issues and bugs that could arise from missing or incompatible components. + +## Preparing Your Game for Distribution + +To prepare your game for distribution on Minekube Games, we simplified the series of steps for you. We provide Dockerfile examples and reusable GitHub Action templates to streamline the packaging and publishing process to Minekube. Here's how you can use these resources: + +1. **Dockerize Your Game**: Docker is a platform that allows you to package your game into a container, making it easy to distribute and run on any system that supports Docker. We provide Dockerfile examples that you can use as a starting point for creating your own Dockerfile. This file will define how to build a Docker image of your game, including all the necessary components and dependencies. + +2. **Set Up GitHub Actions**: GitHub Actions is a CI/CD platform that allows you to automate your software workflows, including building, testing, and deploying your game. We provide reusable templates for GitHub Actions that you can use to automate the packaging and publishing of your game on Minekube Games. These templates include steps for building a Docker image of your game, pushing it to a Docker registry, and releasing it to Minekube Games. + +3. **Test Your Game**: Before distributing your game, you should thoroughly test it to ensure that it works as expected. This includes testing the Docker image of your game to ensure that it runs correctly on different systems and configurations. You can first release your game on a test environment to ensure that it works as expected before publishing it to the public. + +4. **Publish Your Game**: Once your game is packaged and tested, it gets automatically publish on Minekube Games. + +By following these steps, you can ensure that your game is properly packaged and ready for distribution on Minekube Games. This will make it easier for players to install and play your game, and will help to ensure a smooth and enjoyable gaming experience. diff --git a/.web/docs/games/developers/index.md b/.web/docs/games/developers/index.md new file mode 100644 index 0000000..5bac0df --- /dev/null +++ b/.web/docs/games/developers/index.md @@ -0,0 +1,31 @@ +# Overview for Game Developers + +Welcome, creators and visionaries! As a game developer in the Minekube Games ecosystem, you hold the power to shape experiences, craft adventures, and bring imagination to life within the boundless realms of Minecraft. This overview serves as your gateway to understanding how Minekube Games supports you in turning your game development journey into a success story. + +## Minekube Games: A Developer's Playground + +Minekube Games is designed with the developer's needs in mind, providing a suite of tools and services that streamline the path from game conception to global distribution. Our platform simplifies the technical challenges, so you can concentrate on what you do best: **developing**. + +### Key Features for Developers: + +- **Global Distribution**: Reach a vast audience of players by publishing your game packages on Minekube Browser, where they can be discovered and enjoyed by players and server owners worldwide. You don't need to deploy your games on servers, we take care of that for your users. +- **Simplified Deployment:** Utilize our infrastructure to deploy your games swiftly, with support for Kubernetes with integration into our Web UI. +- **Direct Community Engagement:** Connect with players directly, gather feedback, iterate on your creations, and build a following within the Minekube community. +- **Monetization Opportunities:** Choose to offer your games for free or monetize them. Our platform supports various revenue models, giving you control over how you'd like to earn from your work. +- **Transparent Metrics and Reporting:** Gain insights into how your games are performing with our analytics tools, helping you make informed decisions for future development. + +## Getting Started with Minekube Games + +To begin your development journey with Minekube Games, follow these initial steps: + +1. **Familiarize Yourself with Our Tools:** Learn about the technology stack and deployment options available on Minekube. +2. **Prepare Your Game:** Ensure your game meets our guidelines and is packaged correctly for submission. +3. **Launch and Iterate:** Once your game is live, use player feedback and analytics to improve and update your game continuously. + +## Collaborate, Innovate, and Grow + +Minekube Games is not just a platform; it's a collaborative space. We encourage developers to share their knowledge, contribute to the community, and utilize the collective wisdom to drive innovation in Minecraft gaming. + +### Ready to Make Your Mark? + +Join the ranks of Minekube developers who are already transforming the way we play Minecraft. With Minekube Games, your creations have the potential to captivate thousands. Start your development journey with us today, and let's build the future of Minecraft gaming together. \ No newline at end of file diff --git a/.web/docs/games/developers/the-three-ways.md b/.web/docs/games/developers/the-three-ways.md new file mode 100644 index 0000000..b6ad9a6 --- /dev/null +++ b/.web/docs/games/developers/the-three-ways.md @@ -0,0 +1,59 @@ +# The Three Ways: Powering Developer Success on Minekube + +_"I was stuck creating Games nobody played, until I discovered The 3 Ways of Minekube..." - game dev_ + +## Introduction +The Three Ways, a foundational framework that underpins the principles of DevOps as outlined in "The Phoenix Project", provides a structured approach to driving sustainable improvement and high performance in software development and IT operations. This framework is the cornerstone of DevOps, offering a blueprint for operational excellence. At Minekube, these principles are integrated to empower developers, providing a platform for innovation, deployment, and iteration with confidence. Whether through Connect, Games, or Browser, Minekube is committed to the success of developers in the Minecraft ecosystem. + +## The Three Ways on Minekube + +### 1. The First Way: Ensuring Flow + +The First Way, a principle of DevOps, emphasizes the importance of ensuring a smooth, uninterrupted flow of work from development to operations. This approach minimizes work-in-progress, reduces handoffs, and eliminates bottlenecks that can slow down the delivery of value to customers. By focusing on flow, organizations can quickly turn ideas into working software, respond to changing market demands, and deliver value at a sustainable pace. + +In the context of Minekube, this principle is championed through flow thinking, focusing on the performance of the entire system from development through to operations. Your work on Minekube flows uninterrupted from concept to deployment, mirroring the essence of The First Way. Efforts are made to reduce the work-in-progress and eliminate bottlenecks, enabling you to deliver your creations to the Minecraft community swiftly and efficiently. + +- **System Thinking**: On Minekube, your projects benefit from a holistic view. This approach ensures each component works harmoniously within the larger ecosystem, focusing on the performance of the entire system rather than individual departments or silos. It starts when the business identifies requirements and continues through the entire value stream, from building solutions to delivering them to customers as a service. +- **Streamlined Deployments**: Through Minekube Connect, we ensure that games are connected with precision. This feature enables you to respond to architectural changes and the community's needs without delay, further enhancing the flow of work from development to live servers. + +### 2. The Second Way: Embracing Feedback + +The Second Way, a principle of DevOps, revolves around the rapid and constant flow of feedback throughout the development lifecycle. This principle includes gathering feedback from customers, monitoring system performance, and continuously learning from failures and successes. By embracing feedback, organizations can quickly identify and address issues, make data-driven decisions, and continuously improve their processes and products. + +In the context of Minekube, this principle is facilitated through the Browser, where real-world usage and community insights flow back to the developers. This continuous feedback loop empowers you to make data-driven decisions, allowing for rapid iteration and improvement of your games. + +- **Customer Collaboration**: Direct interactions with players on Minekube Games provide invaluable insights. These insights help you refine your creations, ensuring they meet the needs and expectations of the players. +- **Learning from Interactions**: Each user experience on Minekube is an opportunity for learning. This feedback ensures your games evolve in alignment with player expectations, leading to continuous improvement and refinement of your products. + +### 3. The Third Way: Continuous Improvement + +The Third Way, a principle of DevOps, promotes a culture of continuous improvement and learning. This principle encourages fostering an environment where teams are encouraged to experiment, take calculated risks, and learn from their mistakes. By embracing a growth mindset, organizations can continuously enhance their skills, explore new technologies, and drive innovation. + +In the context of Minekube, this ethos of continual learning and experimentation is deeply embedded in the culture. Minekube encourages you to take calculated risks, learn from outcomes, and consistently enhance your skills. With Minekube, you're equipped to push the boundaries of innovation and redefine what's possible in game development. + +- **Experimentation**: Minekube Games serves as your laboratory for innovation. Here, experimentation is not just allowed, but encouraged, and learning from these experiments is celebrated. +- **Growth Mindset**: Minekube fosters an environment that values constant improvement. This ensures that you and your games continue to grow and succeed, aligning with the principle of continuous improvement and learning promoted by the Third Way. + +## Implementing the Three Ways with Minekube + +Adopting The Three Ways, a foundational framework of DevOps, can position developers for success on Minekube and have a transformative impact on an organization's productivity, quality, and overall performance. Here are the key steps: + +1. **Optimize for Flow**: Utilize Minekube Connect to simplify your deployment process, enhancing the flow of work from development to live servers. Minekube Connect acts as a tunnel for Minecraft servers, handling network configuration and reducing complexity. Minekube Games allows developers to flow seamlessly from commit to deploy. This involves identifying and eliminating bottlenecks in your development pipeline, streamlining your deployment processes, and empowering your teams to make decisions that improve the flow of work. +2. **Implement Feedback Loops**: Engage with the community via Minekube Browser and Discord, integrating player feedback into your development cycle for continuous refinement. This also includes establishing regular feedback mechanisms, such as customer interviews, performance monitoring, and retrospective meetings, to continuously gather insights and drive improvement. +3. **Foster Continuous Improvement**: Leverage Minekube's supportive ecosystem to experiment boldly, learn rapidly, and elevate your games to new heights. This involves encouraging your teams to experiment, take calculated risks, and learn from their experiences. Celebrate successes, learn from failures, and continuously invest in the professional development of your employees. + +--- + +By embracing The Three Ways with Minekube, developers can further their journey, deliver exceptional gaming experiences, achieve sustained success in a dynamic marketplace, and unlock the full potential of their DevOps practices. This approach allows developers to deliver high-quality software at a sustainable pace and drive lasting success in the marketplace. + +Minekube not only practices these principles internally but also extends their benefits to you, the developer. By integrating the wisdom of The Three Ways, Minekube creates a space where your potential is limitless, and every challenge is a new opportunity for growth and innovation. + +In a broader context, embracing the Three Ways can have a transformative impact on organizations. It can unlock the full potential of their DevOps practices, enable the delivery of high-quality software at a sustainable pace, and drive lasting success in the marketplace. This approach underscores the importance of these principles in achieving operational excellence and high performance in software development and IT operations. + +--- + +**Citations** +- [The Three Ways: Principles Underpinning DevOps](https://itrevolution.com/articles/the-three-ways-principles-underpinning-devops/) +- [Rediscovering DevOps with Secure Cloud Development Environments](https://thenewstack.io/rediscovering-devops-with-secure-cloud-development-environments/) +- [DevOps Handbook Companion Guide](https://stackoverflow.co/teams/resources/devops-handbook-companion-guide/) +- [Lessons Learned While Writing the DevOps Handbook](https://www.dynatrace.com/resources/ebooks/lessons-learned-while-writing-the-devops-handbook/) \ No newline at end of file diff --git a/.web/docs/games/hosting/container.md b/.web/docs/games/hosting/container.md new file mode 100644 index 0000000..9b93250 --- /dev/null +++ b/.web/docs/games/hosting/container.md @@ -0,0 +1,17 @@ +# Hosting Minekube Games on Docker + +Running Minekube Games within Docker containers is a straightforward way to get your game server up and running. This section guides you through the process of containerizing your Minekube game server for deployment on any system that supports Docker. + +## Why Docker? + +- **Portability**: Docker containers can run consistently across different environments. +- **Isolation**: Each game server operates within its own environment, with dependencies neatly packaged together. +- **Ease of Use**: With Docker, you can easily start, stop, and manage the lifecycle of your game server. + +## Getting Started + +- **Install Docker**: Ensure you have Docker installed on your host machine. +- **Pull the Minekube Games Image**: Fetch the latest game server image from the Minekube registry. +- **Run Your Container**: Start a game server instance with a single Docker command. + +Follow the detailed instructions below to deploy your Minekube Games server in a Docker container. \ No newline at end of file diff --git a/.web/docs/games/hosting/index.md b/.web/docs/games/hosting/index.md new file mode 100644 index 0000000..9bc2166 --- /dev/null +++ b/.web/docs/games/hosting/index.md @@ -0,0 +1,36 @@ +# Hosting Options for Minekube Games + +Minekube Games is designed with versatility in mind to ensure that you can host your game servers in a way that suits your needs and expertise. Whether you prefer to manage your own infrastructure, rely on containerization, or opt for a managed provider, Minekube Games offers the flexibility to accommodate your choice. + +[[TOC]] + +## Compare hosting solutions + +Consider factors like ease of use, existing infrastructure, and developer needs: + +| Feature | [Minekube Providers ->](provider.md) | [Kubernetes ->](kubernetes/) | [Docker ->](container.md) | +|--------------------|---------------------------------------------------------|-------------------------------------------------|----------------------------------------------| +| **Setup** | Easiest | Easy | Moderate | +| **Infrastructure** | Managed | Anywhere | Anywhere | +| **User Interface** | Minekube Web UI | Minekube Web UI | No | +| **Updates** | Automatic | Automatic | Manual | +| **Pricing** | Pay-as-you-go / Subscription / Free | Flexible / Free | Flexible / Free | + +**Recommendations:** + +- For players and low-friction users who want simplicity and ease of use, Minekube Provider's managed solution is recommended, as it offers a user-friendly web UI and handles updates automatically. +- If you already have one or more machines available or an existing Kubernetes cluster, Minekube offers various Kubernetes management levels of control and customization. +- If you're a developer or want to quickly set up a game server without the need for Minekube's web UI and automated updates, Docker can be a lightweight option for running Game containers. + +## Self-hosted Anywhere + +For those who like to keep things under their own control, Minekube Games can run on any platform that supports containers or Kubernetes: + +- **Kubernetes (e.g. k3s)** Recommended: If you're looking for orchestration and scaling capabilities, Kubernetes is the way to go. Whether it's a lightweight k3s setup or a full-fledged Kubernetes cluster, Minekube Games thrives in these environments. +- **Container / Docker** No Minekube Web UI: Ideal for straightforward deployment and local development, running Minekube Games within Docker containers is a popular choice for its simplicity and portability. + +## Managed Provider + +- **Minekube Games Providers**: For ease and convenience, choose one of the Minekube Games Providers. You won't need to worry about the underlying infrastructure and can have your game server up and running in no time, with all the benefits of a managed service. + +Discover the benefits and learn how to get started with each hosting option in the following sections. \ No newline at end of file diff --git a/.web/docs/games/hosting/kubernetes/index.md b/.web/docs/games/hosting/kubernetes/index.md new file mode 100644 index 0000000..c74509a --- /dev/null +++ b/.web/docs/games/hosting/kubernetes/index.md @@ -0,0 +1,44 @@ +# Hosting Minekube Games on Kubernetes + +Kubernetes is the preferred choice for self-hosting or providing Minekube game servers at scale, offering robust management capabilities through the Minekube web dashboard. This section will provide you with the necessary information to deploy and manage your Minekube game servers on Kubernetes, including how to scale up to becoming a provider yourself. + +It's no coincidence that we have `kube` in our name! + +[[TOC]] + +## Why Kubernetes? + +Kubernetes is not just about running containers; it's about simplifying complex technology to provide: + +- **Scalability**: Effortlessly scale your game servers to meet player demand. +- **High Availability**: Achieve high availability with Kubernetes' self-healing and automated rollout/rollback capabilities. +- **Load Balancing**: Efficiently manage traffic distribution across your servers for optimal performance. + +## Exclusive Management via Minekube Dashboard + +One of the unique advantages of choosing Kubernetes for your game servers is the ability to manage everything through the Minekube web dashboard. This centralized management solution provides: + +- **Intuitive Interface**: Easily deploy, monitor, and scale your game servers from a user-friendly web interface. +- **Full Control**: Manage server configurations, updates, and player access with just a few clicks. +- **Visibility**: Get insights into your server's performance and usage patterns to make informed decisions. + +## Path to Becoming a Provider + +By hosting your game servers on Kubernetes, you're already a step ahead in the journey of becoming a provider. With Minekube, you have the option to: + +- **Rent Out Your Hardware**: Offer your Kubernetes cluster's resources to host game servers for friends or paying customers. +- **Expand Your Services**: Grow from hosting servers for personal use to becoming a full-fledged Minekube Games provider. + +See the [Providers Documentation](../../providers/) for more information on how you can leverage your Kubernetes setup to start offering services to others and potentially monetize your infrastructure. + +## Getting Started with Kubernetes + +To launch your Minekube game servers on Kubernetes: + +1. **Prepare Your Kubernetes Cluster**: Whether you're setting up a new cluster or using an existing one, ensure it's configured for Minekube Games. +2. **Deploy Minekube Games**: Use our custom Helm charts or Kubernetes manifests to deploy your game servers with ease. +3. **Manage with Minekube Dashboard**: Connect your cluster to the Minekube web dashboard for comprehensive management and oversight. + +Detailed instructions for each step are provided below, guiding you through the process of deploying and managing your Minekube Games server with Kubernetes. + +Embrace the power of Kubernetes and the convenience of the Minekube dashboard to create an unparalleled gaming experience for your community. Whether for personal enjoyment or as a stepping stone to becoming a provider, Kubernetes offers the flexibility and control you need to succeed in the Minekube ecosystem. \ No newline at end of file diff --git a/.web/docs/games/hosting/kubernetes/level-1.md b/.web/docs/games/hosting/kubernetes/level-1.md new file mode 100644 index 0000000..73007ac --- /dev/null +++ b/.web/docs/games/hosting/kubernetes/level-1.md @@ -0,0 +1,38 @@ +# Level 1: Raw Control with Minimum Management + +## Full Control for Kubernetes Enthusiasts + +Level 1 is catered to users who seek the utmost control over their Kubernetes clusters. It's designed for those who wish to handle everything from the ground up, including the installation and updating of Minekube controllers. At this level, Minekube provides the essential services to facilitate game server management through our web UI. + +## What Level 1 Offers + +- **Maximum Control**: Manage your Kubernetes cluster exactly how you want, with the freedom to configure every aspect. +- **Self-Managed Minekube Controllers**: Install and update Minekube controllers on your own, maintaining full control over the software that powers your game servers. +- **Essential Minekube Support**: We provide the core capabilities needed for you to manage game servers through the Minekube web UI. +- **Direct Cluster Access**: You have the keys to the kingdom, with admin access to your cluster for ultimate transparency and control. + +## Getting Started with Level 1 + +1. **Install Minekube Controllers**: Follow our detailed guides to install the necessary Minekube controllers onto your cluster. + +2. **Access the Web UI**: Use the Minekube web UI to manage your game servers, leveraging our streamlined interface for ease of use. + +3. **Maintain Your Cluster**: Keep your cluster and Minekube controllers up to date, tapping into the full potential of Kubernetes for game server hosting. + +4. **Minekube's Core Support**: Rely on Minekube for essential support and updates that ensure your integration with the web UI remains seamless. + +## Why Choose Level 1? + +Level 1 is perfect for users who: + +- **Desire Ultimate Control**: Take charge of your Kubernetes cluster with the confidence that you're backed by Minekube's foundational support. +- **Want to Tinker and Customize**: Enjoy the freedom to experiment with your cluster setup, knowing that the essential tools for game server management are at your disposal. +- **Prefer a Hands-On Approach**: Engage with every layer of your infrastructure, from the nodes to the networking, with Minekube providing the necessary components for game server management. + +## Conclusion + +Level 1 offers the greatest degree of autonomy, putting you in full command of your Kubernetes cluster while still providing access to Minekube's web UI for managing game servers. This level is for the Kubernetes purists, the tinkerers, and the innovators who want to shape every detail of their infrastructure. + +--- + +For assistance with setting up your Minekube controllers or optimizing your cluster for game server hosting, consult our extensive documentation or reach out to our dedicated support team. We're here to ensure that even at the highest level of control, you have the resources and support to succeed. \ No newline at end of file diff --git a/.web/docs/games/hosting/kubernetes/level-2.md b/.web/docs/games/hosting/kubernetes/level-2.md new file mode 100644 index 0000000..2d75127 --- /dev/null +++ b/.web/docs/games/hosting/kubernetes/level-2.md @@ -0,0 +1,38 @@ +# Level 2: Admin Access to Your Cluster + +## Custom Kubernetes Management with Minekube Integration + +Level 2 strikes the balance for users who want to manage their Kubernetes cluster while leveraging the Minekube platform for deploying game servers. You provide the cluster, and we bring our Minekube controllers and web UI expertise to ensure your game servers run without a hitch. + +## What Level 2 Offers + +- **Your Kubernetes, Your Rules**: Bring your own Kubernetes cluster, and we'll integrate it with the Minekube platform. +- **Minekube Controllers Management**: We deploy and manage the Minekube controllers, so your game server runs smoothly on your own infrastructure. +- **Direct Web UI Access**: Manage your game servers with the convenience of the Minekube web UI, while retaining full control over your Kubernetes operations. +- **Focus on What Matters**: We take care of integrating Minekube Games into your cluster, allowing you to focus on administration and high-level decisions. + +## Getting Started with Level 2 + +1. **Provide Admin Access**: Grant Minekube administrative access to your Kubernetes API so we can integrate our controllers seamlessly. + +2. **Web UI Integration**: Once integrated, you'll have access to the Minekube web UI, bringing a user-friendly interface to your Kubernetes management experience. + +3. **Retain Full Control**: Continue to manage and scale your Kubernetes cluster, ensuring it meets your specific needs and preferences. + +4. **Minekube Support**: Take advantage of Minekube's expertise in managing game server workloads, with our support team ready to assist when needed. + +## Why Choose Level 2? + +Level 2 is designed for users who seek: + +- **Hands-On Management**: Enjoy the autonomy of managing your Kubernetes infrastructure with the added benefit of Minekube's specialized game server management. +- **Streamlined Game Server Deployment**: With the heavy lifting done by Minekube, deploying and managing game servers becomes a breeze. +- **Custom Infrastructure with Managed Support**: Combine your customized Kubernetes setup with the robust support of Minekube's managed services. + +## Conclusion + +Level 2 is the ideal choice for Kubernetes enthusiasts who value the control over their environment and appreciate the specialized support that Minekube provides. With Level 2, you manage your cluster your way, with Minekube enhancing your game server operations. Get started with Level 2 and elevate your Kubernetes experience. + +--- + +To learn more about integrating your Kubernetes cluster with Minekube or for guidance on managing your environment, please refer to our comprehensive documentation or contact our expert support team. \ No newline at end of file diff --git a/.web/docs/games/hosting/kubernetes/level-3.md b/.web/docs/games/hosting/kubernetes/level-3.md new file mode 100644 index 0000000..7901ed5 --- /dev/null +++ b/.web/docs/games/hosting/kubernetes/level-3.md @@ -0,0 +1,38 @@ +# Level 3: Bootstrapping a k3s Cluster by Command + +## Seamless Kubernetes Integration with Minekube + +Level 3 is designed for those who prefer a hands-on approach with the added convenience of Minekube's managed services. This level simplifies the process of setting up a Kubernetes cluster using k3s while providing automatic integration with the Minekube web UI. You command the setup; we ensure it runs like clockwork. + +## What Level 3 Offers + +- **Guided Cluster Setup**: With a single command, you can bootstrap a fully functional k3s cluster, tailored for running Minekube Games. +- **Automatic Web UI Integration**: Your cluster automatically connects to the Minekube web UI, allowing you to manage your game servers with ease. +- **Managed Minekube Services**: We take care of deploying and managing Minekube controllers, ensuring seamless updates and performance optimization. +- **User-Controlled Kubernetes Operations**: You maintain the freedom to manage your cluster, perform node upgrades, and handle the Kubernetes operations you're familiar with. + +## Getting Started with Level 3 + +1. **Bootstrap Your Cluster**: Run our provided command on your server to start the k3s installation and connect to the Minekube ecosystem. + +2. **Connect to the Web UI**: Log into the Minekube web UI where you can start managing your game servers immediately. + +3. **Enjoy Managed Controllers**: We manage the Minekube-specific components, keeping your server's gameplay experience smooth and engaging. + +4. **Handle Kubernetes Your Way**: With admin access, you manage the Kubernetes operations, giving you control over your infrastructure while we support the Minekube layer. + +## Why Choose Level 3? + +Level 3 is perfect for users who want: + +- **Control with Convenience**: You're in charge of your cluster but without the hassle of managing Minekube services. +- **Simplified Operations**: While you focus on the Kubernetes side, we ensure the Minekube components are always up-to-date and functioning optimally. +- **Best of Both Worlds**: Enjoy the autonomy of managing your infrastructure paired with the support of Minekube's managed services. + +## Conclusion + +Level 3 combines the satisfaction of self-management with the comfort of Minekube's expertise. It's the ideal middle ground for those who enjoy Kubernetes administration but also appreciate the ease of managed Minekube services. Start your journey with Level 3 today and experience the power of Kubernetes with the support of Minekube. + +--- + +For detailed instructions on bootstrapping your k3s cluster or any additional support, please consult the Minekube documentation or contact our support team. We are here to assist you every step of the way. \ No newline at end of file diff --git a/.web/docs/games/hosting/kubernetes/level-4.md b/.web/docs/games/hosting/kubernetes/level-4.md new file mode 100644 index 0000000..3eb333e --- /dev/null +++ b/.web/docs/games/hosting/kubernetes/level-4.md @@ -0,0 +1,41 @@ +# Level 4: Fully Managed on Your Cloud + +## Fully Hands-Off Kubernetes Management + +Welcome to Level 4 of Minekube's Kubernetes Management — the pinnacle of ease and automation. This level is designed for those who prefer a hands-off approach and wish to delegate the complexities of cluster management to the experts at Minekube. Provide us with the API key from your cloud provider of choice, and we will handle everything from infrastructure setup to Kubernetes management. Sit back, and watch your Minecraft game server come to life with minimal input and maximum efficiency. + +## What Level 4 Offers + +- **Fully Managed Kubernetes Experience**: We create and manage your Kubernetes cluster in its entirety, from provisioning resources to configuring network settings. +- **Zero Infrastructure Setup**: No need to procure or prepare hardware. We orchestrate the cloud resources directly, spinning up the necessary infrastructure on your behalf. +- **Direct Cloud Provider Billing**: With Level 4, you're only billed for the resources you consume by your cloud provider. There are no hidden fees or additional charges from Minekube. +- **One-Click Minekube UI Integration**: Access the full suite of Minekube Games capabilities through a single, unified web interface, designed for ease of use and comprehensive control. +- **Admin Access to Your Cluster**: Despite the managed nature of Level 4, you retain full administrative privileges, ensuring transparency and oversight. + +## Getting Started with Level 4 + +1. **API Key Provisioning**: Securely provide us with an API key from your cloud provider that has the necessary permissions for resource management. + +2. **Cluster Creation**: We initiate the cluster creation process, provisioning the machines, and setting up a Kubernetes cluster tailored to host Minekube Games efficiently. + +3. **Automatic Setup**: Once the infrastructure is ready, we automatically deploy Minekube's software stack, including all the Kubernetes resources needed for optimal game server operation. + +4. **Minekube Web UI Access**: Log in to the Minekube web UI to manage your game servers. Enjoy the simplicity of one-click deployments, updates, and scaling options. + +5. **Ongoing Management**: We take care of all the operational aspects, such as monitoring, updates, and security, ensuring your game servers are always running smoothly. + +## Why Choose Level 4? + +Level 4 is ideal for those who seek: + +- **Effortless Deployment**: Launching a game server should be as simple as playing the game itself. With Level 4, we ensure that's exactly what you experience. +- **Professional Management**: Our team of Kubernetes experts becomes your team. We manage your cluster with the same care and precision we use for our systems. +- **Focus on Development**: Free yourself from the operational overhead. Concentrate on game development and let us handle the rest. + +## Conclusion + +Embrace the simplicity of Level 4 Kubernetes Management for Minekube Games. Experience the freedom to innovate without the burden of infrastructure management. This is the future of game server hosting — efficient, seamless, and fully managed. Get started today and transform the way you deploy and manage Minecraft servers. + +--- + +For any inquiries or to begin the setup process, please reach out to Minekube support, and we'll guide you through each step of the journey to a fully managed Kubernetes experience. \ No newline at end of file diff --git a/.web/docs/games/hosting/kubernetes/levels.md b/.web/docs/games/hosting/kubernetes/levels.md new file mode 100644 index 0000000..6b4089c --- /dev/null +++ b/.web/docs/games/hosting/kubernetes/levels.md @@ -0,0 +1,82 @@ +# Kubernetes Management Levels + +At Minekube, we understand that every user has different needs and preferences when it comes to managing their Kubernetes cluster. That's why we offer four different levels of management, ranging from fully managed to highly customizable. + +No matter which level you choose, you'll always have admin access to your final Kubernetes cluster, and our goal is to provide a managed experience through the web UI. However, the more custom your setup, the less likely you'll be able to manage lower-level operations through the web UI. + +[[TOC]] + +## Comparison Table + +Here's a detailed comparison table for the different Kubernetes management levels offered by Minekube: + +| Feature/Level | Fully Managed on Your Cloud | Bootstrapping a k3s Cluster by Command | Admin Access to Your Cluster | Raw Control with Minimum Management | +|---------------------------------|---------------------------------------------|------------------------------------------------|---------------------------------------------|---------------------------------------------| +| **Go to Guide** | [Level 4 ->](level-4.md) | [Level 3 ->](level-3.md) | [Level 2 ->](level-2.md) | [Level 1 ->](level-1.md) | +| **Minekube Support** | Full | Full | [Plus only](/plans) | [Plus only](/plans) | +| **Cluster Setup** | Minekube-managed | User-managed, Minekube-assisted setup | User-managed | User-managed | +| **Infrastructure Management** | Minekube-managed | Minekube-managed | User-managed | User-managed | +| **Minekube Controllers** | Minekube-managed | Minekube-managed | Minekube-managed | User-managed | +| **Web UI Integration** | Automatic | Automatic | Automatic | Manual setup | +| **Node Management** | Minekube-managed | Minekube-managed | User-managed | User-managed | +| **Node Upgrades** | Minekube-managed | Minekube-managed | User-managed | User-managed | +| **Cloud Provider Billing** | Direct with provider | N/A (self-hosted k3s) | N/A (user-provided cluster) | N/A (user-provided cluster) | +| **Kubernetes API Admin Access** | Yes | Yes | Yes | Yes | +| **Customization Level** | Low (fully managed) | Moderate | High | Very High | +| **User Involvement** | Minimal | Moderate | High | Very High | +| **Ease of Onboarding** | Very Easy | Easy | Moderate | Requires technical expertise | +| **Best Suited For** | Users seeking hands-off management | Users comfortable with command-line operations | Experienced Kubernetes users | Kubernetes experts | + +> This table summarizes the key differences between each management level to help users decide which option best fits their needs. Whether you're looking for a fully managed service or prefer to have granular control over every aspect of your Kubernetes cluster, Minekube has a solution to support your game server hosting requirements. + + +## Level 4: Fully Managed on Your Cloud + +[Go to Level 4 Guide ->](level-4.md) + +- **Description**: You only need to provide us with an API key from your preferred cloud provider, and we'll take care of the rest. We create machines, set up Kubernetes, and manage everything on your behalf. You don't even need an existing machine—all aspects are handled by us. Simply pay your cloud provider directly for the resources used. +- **Features**: + - Fully managed Kubernetes cluster on your cloud provider + - Machine creation, Kubernetes setup, and management handled by us + - Automatic connection to the Minekube web UI to manage everything + - No need to have an existing machine or run any commands + - Pay your cloud provider directly for resources used + + +## Level 3: Bootstrapping a k3s Cluster by Command + +[Go to Level 3 Guide ->](level-3.md) + +- **Description**: At this level, we provide documentation explaining how to bootstrap a k3s cluster with a single command and automatically connect to the Minekube web UI. We control everything, from installing Kubernetes properly to node upgrades and deploying our controllers. This is the most managed level, offering simplicity and ease of use. +- **Features**: + - Single command to set up a Kubernetes cluster using k3s + - Automatic connection to the Minekube web UI to manage everything + - Handled by us: installation, node upgrades, deployment of controllers, and more + +## Level 2: Admin Access to Your Cluster + +[Go to Level 2 Guide ->](level-2.md) + +- **Description**: For users who want to choose how their Kubernetes cluster is set up. You maintain admin access to your Kubernetes API, allowing you to use our Minekube web UI seamlessly. While we handle the deployment and management of our controllers, as well as software updates and UI integration, you're responsible for node upgrades. We don't handle lower-level Kubernetes operations at this level. +- **Features**: + - More control over your Kubernetes cluster + - Convenience of using our Minekube web UI to manage everything except kubernetes nodes + - Handled by us: deployment and management of controllers, software updates, and integration with our UI + - Responsible for node upgrades + +## Level 1: Raw Control with Minimum Management + +[Go to Level 1 Guide ->](level-1.md) + +- **Description**: This level is for users who desire the most raw control. You're responsible for ensuring our Minekube controllers are installed and kept updated on your cluster. We only handle core tasks necessary for you to manage game servers through our Minekube web UI. There's minimal management from our side—no controller updates, no node updates, just essential support for UI integration. +- **Features**: + - Most control over your Kubernetes cluster + - Convenience of using our Minekube web UI to manage game servers only + - Responsible for installing and updating our controllers, node updates, and other lower-level Kubernetes operations + - Handled by us: core tasks necessary to allow you to manage game servers through our Minekube web UI + +## Getting Started + +To get started, choose the management level that's right for you. We recommend starting with Level 4 if you're new to Kubernetes or want a simple and easy way to set up a cluster. If you want more control over your cluster, consider Level 2 or Level 3. + +Once you've chosen your management level, follow the instructions on the corresponding level guide page to get started. If you have any questions or need help, don't hesitate to contact us. diff --git a/.web/docs/games/hosting/provider.md b/.web/docs/games/hosting/provider.md new file mode 100644 index 0000000..6326344 --- /dev/null +++ b/.web/docs/games/hosting/provider.md @@ -0,0 +1,17 @@ +# Using a Managed Provider for Minekube Games + +If you want to skip the hassle of managing infrastructure, a Minekube Games managed provider is the perfect solution. This option allows you to create and maintain your game server with ease, without needing to worry about the technical details of server management. + +## Advantage of Managed Providers + +- **Speed of Setup**: Launch your game servers quickly with pre-configured settings. +- **Reduced Maintenance**: Let the provider handle updates, backups, and security. +- **Support**: Access professional support and services to keep your server running smoothly. + +## How to Get Started + +- **Select a Provider**: Choose from a list of Minekube-approved game server providers. +- **Customize Your Server**: Pick your game, configure server settings, and get ready to launch. +- **One-Click Management**: Everything at one place, use the Minekube Dashboard to manage your game server on any provider, make changes, and more. + +Explore [Creating a Game Server ->](../servers/create) to find out more about choosing a Minekube Games managed provider and getting your server online today. diff --git a/.web/docs/games/index.md b/.web/docs/games/index.md new file mode 100644 index 0000000..c4a8c45 --- /dev/null +++ b/.web/docs/games/index.md @@ -0,0 +1,27 @@ +# Welcome to Minekube Games + +_"I was stuck creating Games nobody played, until I discovered The 3 Ways of Minekube..." - game dev_ + +## Introduction + +Minekube Games reimagines the gaming experience within the Minecraft ecosystem by providing a unified platform that connects game developers, server owners, hosting providers, and players. Our mission is to streamline the way Minecraft games are created, deployed, and enjoyed, ensuring an accessible, fulfilling, and community-driven experience for all. + +At the heart of Minekube Games lies a commitment to simplification without sacrifice — making it easier for developers to bring their visions to life, for server owners to manage and scale their worlds, for hosting providers to offer their services, and for players to discover and dive into new adventures. + +### Key Features for Our Audiences: + +- **Game Developers:** Enjoy a straightforward pathway to game deployment with Minekube's containerization tools and robust infrastructure. Engage with a community eager for fresh content, and benefit from a platform that supports both free and monetized game distribution. + +- **Server Owners:** Whether you're looking to create a private server for a close-knit group or a public server for the wider world, Minekube Games offers the tools to launch and manage your server with ease, backed by comprehensive analytics and community feedback mechanisms. + +- **Hosting Providers:** Integrate your services effortlessly with our platform. Take advantage of Minekube's Bring Your Own Cloud (BYOC) feature, transparent billing, and a marketplace that connects you with customers looking for quality hosting solutions. + +- **Players:** Discover a curated selection of games and servers, join vibrant communities, and shape the gaming landscape through ratings, reviews, and direct feedback to creators. + +Minekube Games is more than just a platform; it's a catalyst for connection and innovation in the Minecraft universe. Whether you're building worlds from the ground up or looking for your next gaming experience, Minekube Games is your gateway to endless possibilities. + +Let's embark on this journey together and define the future of Minecraft gaming. + +--- + +_"I was bored playing the same Games over and over again, until I discovered Minekube Games..." - player_ diff --git a/.web/docs/games/providers/index.md b/.web/docs/games/providers/index.md new file mode 100644 index 0000000..daa13fb --- /dev/null +++ b/.web/docs/games/providers/index.md @@ -0,0 +1,30 @@ +# Overview for Hosting Providers + +Welcome to Minekube Games, where hosting providers like you are integral to powering the diverse array of Minecraft experiences available to players around the world. This overview will introduce you to the tools and opportunities Minekube Games offers to enhance your hosting services and expand your reach within the Minecraft community. + +## Minekube Games: A Partner in Hosting Excellence + +Minekube Games recognizes the crucial role hosting providers play in the gaming ecosystem. We're dedicated to offering a partnership that supports your growth, streamlines your operations, and connects you with a vast audience of server owners and game developers. + +### Advantages for Hosting Providers: + +- **Seamless Integration:** Easily integrate your hosting services with Minekube Games using our Bring Your Own Cloud (BYOC) feature, and manage everything from a single, centralized dashboard. +- **Transparent Billing:** Benefit from our clear, usage-based billing system, ensuring you only pay for the resources you use, with no hidden fees. +- **Marketplace Exposure:** Gain visibility in our marketplace, where server owners and developers are actively seeking reliable and high-performance hosting solutions. +- **Scalable Infrastructure:** Utilize our scalable infrastructure to match your service offerings with the fluctuating demands of Minecraft servers, ensuring efficiency and customer satisfaction. + +## Launching Your Hosting Services on Minekube Games + +To begin offering your hosting services on Minekube Games, follow these foundational steps: + +1. **Familiarize with Minekube Integration:** Understand how to connect your hosting solutions with our platform, ensuring a smooth integration process. +2. **List Your Services:** Showcase your hosting packages, highlight unique selling points, and set competitive pricing to attract server owners and developers. +3. **Optimize and Automate:** Leverage Minekube's tools for server deployment, autoscaling, and resource management to provide an outstanding user experience. + +## Commitment to Collaborative Growth + +Minekube Games is committed to a collaborative relationship with hosting providers. We continuously seek feedback and input to improve our platform and make it the go-to choice for Minecraft hosting services. + +### Ready to Amplify Your Hosting Business? + +Join Minekube Games to elevate your hosting services to new heights. With our support and your expertise, together we can provide the backbone for unforgettable Minecraft gaming experiences. Let's start this partnership and set a new standard in Minecraft hosting. \ No newline at end of file diff --git a/.web/docs/games/providers/payouts.md b/.web/docs/games/providers/payouts.md new file mode 100644 index 0000000..d212e62 --- /dev/null +++ b/.web/docs/games/providers/payouts.md @@ -0,0 +1,3 @@ +# TBD + +- stripe payout supports multiple currencies and methods like bank transfer, debit card, crypto, etc. \ No newline at end of file diff --git a/.web/docs/games/providers/selling.md b/.web/docs/games/providers/selling.md new file mode 100644 index 0000000..bf691c0 --- /dev/null +++ b/.web/docs/games/providers/selling.md @@ -0,0 +1,4 @@ +# TBD + +- minekube browser marketplace +- seamless minekube stripe connect onboarding \ No newline at end of file diff --git a/.web/docs/games/servers/create.md b/.web/docs/games/servers/create.md new file mode 100644 index 0000000..a2634eb --- /dev/null +++ b/.web/docs/games/servers/create.md @@ -0,0 +1,35 @@ +# Creating a Game Server on Minekube + +Welcome to the initial step of bringing your Minecraft world to life on Minekube. Whether you're setting up a private server for you and your friends or planning to launch a public server for the community, this guide will walk you through creating your own game server on the Minekube platform, whether self-hosted or managed the web interface is always the same. + +## Choose Your Game + +**1. Explore the Catalog:** Start by browsing the Minekube Games catalog. Whether you're looking for a classic experience or something new with mods and custom worlds, you'll find it here. + +**2. Select a Game Package:** Each game has specially tailored server packages. Choose the one that best fits the experience you want to provide on your server. + +## Configure Your Server + +**3. Customize Server Settings:** Name your server, select the optimal region for your player base, and configure privacy settings. + +**4. Allocate Resources:** Decide on the CPU and memory allocations to ensure your server runs smoothly. + +**5. Set Advanced Options (Optional):** For those with specific requirements, fine-tune your server with custom settings for plugins, world generation, and more. + +## Deploy and Manage + +**6. Deployment:** Once you're happy with your choices, it's time to deploy. Our system will handle the setup and inform you when your server is ready. + +**7. Management Dashboard:** Use our comprehensive dashboard to control your server, from modifying settings to scaling resources as needed. + +## Get Ready to Play + +**8. Connect and Enjoy:** With your server up and running, connect to your new world and start your Minecraft adventure. + +**9. Invite Your Friends (For private servers):** If you've set up a private server, invite your friends to join and play together. + +--- + +*Hint: If you're considering making your server public and want to share it with the wider Minekube community, take a look at our [Launch Your Server](../../browser/launch/server) documentation next. It's a great way to gain visibility and players - and if you don't have a game server yet, we highly recommend creating one. You can even host game servers on your own infrastructure if you prefer.* + +By following these steps, you'll set up a game server tailored to your preferences, ready for whatever Minecraft experience you're looking to create. Enjoy the journey, and happy crafting! \ No newline at end of file diff --git a/.web/docs/games/servers/index.md b/.web/docs/games/servers/index.md new file mode 100644 index 0000000..d4a11ba --- /dev/null +++ b/.web/docs/games/servers/index.md @@ -0,0 +1,30 @@ +# Overview for Server Owners + +As a server owner within the Minekube Games environment, you are the architect of online spaces where players gather, collaborate, and create memories. This overview is crafted to guide you through the capabilities and resources provided by Minekube Games, ensuring your server thrives and becomes a cornerstone of the community. + +## Minekube Games: Empowering Server Owners + +At Minekube Games, we understand the passion and commitment that goes into running a Minecraft server. That's why we've tailored our platform to simplify management tasks, enhance your server's potential, and connect you with a network of eager players. + +### Key Benefits for Server Owners: + +- **Easy Setup and Configuration:** Launch a server with just a few clicks, selecting from a variety of games and customizing your settings to match your vision. +- **Robust Management Tools:** Access a comprehensive dashboard that allows you to monitor server health, manage player permissions, and adjust configurations as needed. +- **Community Building:** Leverage Minekube's community features to engage with players, gather feedback, and foster a lively and welcoming environment. +- **Scalability:** Whether anticipating a surge in players or scaling down, adjust your server's resources with flexibility to ensure optimal performance at all times. + +## Initiating Your Server Journey + +To start your server ownership journey, consider these steps: + +1. **Choose Your Game:** Select from the diverse catalog of games available on Minekube Games, each ready to be transformed into a unique server experience. +2. **Configure and Customize:** Tailor your server's settings to create the ideal environment for your player base, from survival challenges to creative freebuilds. +3. **Launch Your Server:** Deploy your server to the public, or keep it private for a select group of friends. Either way, Minekube Games facilitates a smooth launch process. + +## Creating Lasting Experiences + +Your server is more than just a game; it's a community and an experience that can leave a lasting impression on its members. Minekube Games gives you the tools and support to ensure your server is not only successful but also a place where players feel at home. + +### Ready to Build Your Community? + +Step into the role of server owner with confidence, knowing that Minekube Games is here to support your endeavors every step of the way. Create, manage, and grow your server—starting now—and watch as players fill your world with their own stories and creations. \ No newline at end of file diff --git a/.web/docs/games/servers/players.md b/.web/docs/games/servers/players.md new file mode 100644 index 0000000..09c12f5 --- /dev/null +++ b/.web/docs/games/servers/players.md @@ -0,0 +1,30 @@ +# Overview for Players + +Embark on an adventure with Minekube Games, where players are the heart and soul of the Minecraft universe. This overview is your introduction to a world of discovery, where you can explore an array of servers, engage with unique game experiences, and join a community that's as passionate about Minecraft as you are. + +## Minekube Games: Your Portal to Minecraft Discovery + +Minekube Games is more than just a collection of servers — it's a curated experience designed to connect you with the games you love and the communities that bring them to life. + +### Features for Players: + +- **Discover New Worlds:** Dive into a diverse catalog of servers and games, each with its own flavor and community. +- **Join and Play Instantly:** With a few clicks, join any game server that catches your eye and start playing right away. +- **Shape the Game:** Your opinions matter. Rate, review, and provide feedback on game servers to help shape their future and guide other players. +- **Be Part of the Community:** Participate in discussions, contribute to forums, and engage with other players and server owners to enrich the Minekube Games experience. + +## Starting Your Journey with Minekube Games + +Begin your quest in the Minekube Games universe by following these steps: + +1. **Explore the Catalog:** Browse through the carefully curated game and server listings to find your next adventure. +2. **Connect with Ease:** Learn how to quickly join a server and troubleshoot any issues with our helpful guides. +3. **Get Involved:** Discover how to become an active member of the community, from leaving reviews to participating in events and discussions. + +## Crafting Your Story + +Every player's journey is unique, and Minekube Games gives you the freedom to craft your own story. From the thrill of survival challenges to the creativity of building spectacular structures, your path is yours to decide. + +### Ready to Join the Adventure? + +Your next unforgettable Minecraft experience awaits. With Minekube Games, you're not just joining servers; you're stepping into new worlds ready to be explored and enjoyed. Grab your gear, rally your friends, and let's start playing. \ No newline at end of file diff --git a/.web/docs/games/vision.md b/.web/docs/games/vision.md new file mode 100644 index 0000000..358d9c8 --- /dev/null +++ b/.web/docs/games/vision.md @@ -0,0 +1,41 @@ +# Vision of Minekube Games + +## A Unified Ecosystem for Builders and Players + +Minekube Games is not just a platform; it's a vision realized — a comprehensive ecosystem where the creativity of game developers, the diligence of server owners, the reliability of hosting providers, and the enthusiasm of players converge to create a rich, seamless Minecraft experience. + +### Empowering Developers + +We envision a space where developers can focus on what they love: crafting engaging Minecraft experiences. With Minekube Games, the complexities of distribution, server management, and player feedback are streamlined, allowing developers to innovate and share their creations with confidence. + +### Enabling Server Owners + +- The Most Innovative Minecraft Servers launch and promote on the Minekube Browser. + +Server owners are the backbone of the Minecraft community. Our vision includes providing them with the tools they need to manage and scale their servers efficiently, enabling them to create communities and experiences that players will return to time and again. + +### Supporting Hosting Providers + +- We bring the customers, you bring the compute. Connect your nodes to Minekube Games and let us handle the rest: Interfaces, Billing, Payout, Game management, and more. + +Hosting providers play a crucial role in powering the Minecraft universe. Minekube Games aims to simplify the integration and management of hosting services, ensuring providers can focus on delivering their machines into production with ease and transparency. + +### Engaging Players + +- Discover the hottest servers to play right now! Launch Games faster in Minecraft. Ready to play Games Anywhere, Self-host or public Localhost for Multiplayer. + +At the core of Minekube Games lies the ultimate end-user: the player. Our platform is designed to offer players a diverse array of games and servers, fostering a community where their voices help shape the landscape and where discovery is part of the adventure. + +### Our Commitment to Growth and Innovation + +Minekube Games is committed to continuous growth and innovation. We actively listen to our community, seeking feedback and implementing changes that enhance the platform for all users. Our roadmap includes: + +- **Community-Centric Features:** Developing tools that foster interaction, collaboration, and community building. +- **Robust Infrastructure:** Ensuring our technology stack is scalable, secure, and state-of-the-art, providing a reliable foundation for all users. +- **Seamless Experience:** Creating a user-friendly environment that makes navigation, discovery, and participation intuitive and enjoyable. + +### Join Us in Shaping the Future + +The future of Minekube Games is bright, and it's shaped by every developer, server owner, hosting provider, and player who joins us. Together, we can create an ecosystem that's not only about playing Minecraft but about expanding its horizons to new levels of creativity and enjoyment. + +Embark on this journey with us, and let's build the future of Minecraft gaming — together. \ No newline at end of file