Skip to content

Commit

Permalink
docs(browser): Introducing Minekube Browser
Browse files Browse the repository at this point in the history
  • Loading branch information
robinbraemer committed Apr 12, 2024
1 parent 59c2226 commit dcae8e2
Show file tree
Hide file tree
Showing 14 changed files with 357 additions and 0 deletions.
76 changes: 76 additions & 0 deletions .web/docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,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,
Expand Down Expand Up @@ -202,6 +204,80 @@ 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: 'Creating a Game Server', link: '/browser/create-server'},
{
text: 'Launching', link: '/browser/launch/', items: [
{text: 'Launch Your Server', link: '/browser/launch/server'},
{text: 'Launch Your Game', link: '/browser/launch/game'},
]
}
]
},
],
'/games/': [
{
text: 'Minekube Games',
items: [
{text: 'Introduction', link: '/games/'},
]
},
{
text: 'Go to your right place',
items: [
{text: 'For Game Developers →', link: '/games/developers/'},
{text: 'For Server Owners →', link: '/games/servers/'},
{text: 'For Hosting Providers →', link: '/games/providers/'},
{text: 'For Players →', link: '/games/players/'},
]
},
],
'/games/developers/': [
{
text: 'Minekube Games Developers',
items: [
{text: 'Overview', link: '/games/developers/'},
]
},
{text: '← Back to Selection', link: '/games/'},
],
'/games/players/': [
{
text: 'Minekube Games Players',
items: [
{text: 'Overview', link: '/games/players/'},
]
},
{text: '← Back to Selection', link: '/games/'},
],
'/games/providers/': [
{
text: 'Minekube Games Providers',
items: [
{text: 'Overview', link: '/games/providers/'},
]
},
{text: '← Back to Selection', link: '/games/'},
],
'/games/servers/': [
{
text: 'Minekube Games Servers',
items: [
{text: 'Overview', link: '/games/servers/'},
]
},
{text: '← Back to Selection', link: '/games/'},
],
}
}
})
35 changes: 35 additions & 0 deletions .web/docs/browser/create-server.md
Original file line number Diff line number Diff line change
@@ -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](./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!
13 changes: 13 additions & 0 deletions .web/docs/browser/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Welcome to Minekube Browser Documentation

## Introduction

Welcome to Minekube Browser, the quintessential platform where the vast world of Minecraft meets innovation, community, and seamless integration. This is your ultimate guide through the expansive services and opportunities provided by Minekube Browser, an integral part of Minekube's growing ecosystem. Whether you're a player seeking adventure, a developer crafting 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 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 and customers, focusing on the practicalities and benefits of our platform without delving into the internal implementation details. As we walk you through the Minekube Browser, you'll understand how it caters to the needs of various stakeholders in the Minecraft ecosystem, from players to developers, to hosting providers.

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 Minekube Browser offers.

Welcome aboard the new chapter of Minecraft server exploration and game building — Welcome to Minekube Browser.
56 changes: 56 additions & 0 deletions .web/docs/browser/launch/game.md
Original file line number Diff line number Diff line change
@@ -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.
47 changes: 47 additions & 0 deletions .web/docs/browser/launch/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Launching Overview on Minekube

Welcome to the central hub of launching on Minekube, where we empower server creators and game developers to showcase their creations to a passionate Minecraft community. This guide provides an overview of the launch process, offering insights into how to make your game or server stand out and captivate players.

## What Does Launching Mean on Minekube?

Launching on Minekube refers to the process of publicizing a game or game server, making it available to players worldwide. This involves not only technical setup but also community engagement and marketing strategies to ensure a successful introduction to the market.

## Launching a Game Server

For those who have crafted a unique server experience for players:

- **Preparation:** Ensure your game server is configured, polished, and ready for public access.
- **Visibility:** Decide on your server’s visibility in the Minekube community, and set it up for discovery.
- **Engagement:** Engage with potential players, gather feedback, and build a community around your server.

Refer to our [Creating a Game Server](./server) documentation to set up your server, and when ready, follow the steps in our [Launching a Server](./server) guide to go public.

## Launching a Game

For game developers looking to publish their games:

- **Development:** Containerize your game and prepare it for deployment on Minekube.
- **Presentation:** Craft compelling descriptions and media to attract players to your game.
- **Community Interaction:** Build hype, collect feedback, and foster a player base for your game.

To understand the full process, visit our [Launching a Game](./game) documentation for detailed steps and best practices.

## The Lifecycle of a Launch

A launch on Minekube is not a one-time event but a lifecycle that includes:

- **Pre-Launch:** The planning and preparation phase where you set the stage for your launch.
- **Launch Day:** The day your game or server goes live, which should be marked with promotional activities and community engagement.
- **Post-Launch:** The ongoing process of supporting, updating, and growing your game or server based on player feedback and analytics.

## Why Launch with Minekube?

- **Access to a Dedicated Community:** Tap into a built-in audience of Minecraft enthusiasts ready to explore new content.
- **Robust Infrastructure:** Rely on our solid platform designed for seamless game and server experiences.
- **Support and Tools:** Utilize our comprehensive suite of tools and resources to manage and promote your launch effectively.

Launch on Minekube to turn your Minecraft visions into reality, engage with a global audience, and grow your presence in the Minecraft ecosystem. We're here to support you every step of the way.

---

*Remember, a successful launch is the result of careful planning, quality content, and active community engagement. Whether you're launching a game or a game server, Minekube is the platform where your Minecraft creations take flight.*
38 changes: 38 additions & 0 deletions .web/docs/browser/launch/server.md
Original file line number Diff line number Diff line change
@@ -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](../create-server) 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.*
19 changes: 19 additions & 0 deletions .web/docs/browser/platform.md
Original file line number Diff line number Diff line change
@@ -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 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 understands and enhances the gaming landscape.

Loading

0 comments on commit dcae8e2

Please sign in to comment.