116 lines
No EOL
4.8 KiB
HTML
116 lines
No EOL
4.8 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<link rel="stylesheet" href="/neoBeta/assets/stylesheets/styles.css" media="screen">
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>neoBeta</title>
|
|
</head>
|
|
<body>
|
|
<script>
|
|
window.ELEVENTY_PATH_PREFIX = "/neoBeta/";
|
|
</script>
|
|
<div id="everythingHelper">
|
|
<aside>
|
|
<header>
|
|
<div id="linksBox">
|
|
<div id="headerLinksAndTitle">
|
|
<div id="logoTitle">
|
|
<img src="/neoBeta/assets/logo.png" id="logo">
|
|
<h1 id="title" class="rainbowText">neoBeta</h1>
|
|
</div>
|
|
<ul id="headerLinks">
|
|
<li><a href="/neoBeta/">home</a></li>
|
|
<li><a href="/neoBeta/search">search</a></li>
|
|
<li><a href="/neoBeta/allprojects">index</a></li>
|
|
<li><a href="/neoBeta/contribute">contribute</a></li>
|
|
</ul>
|
|
</div>
|
|
<p id="credits">Adrian Victor, 2025 (<a href="https://git.disroot.org/adrianvictor/neoBeta">Unlicense</a>)</p>
|
|
</div>
|
|
</header>
|
|
</aside>
|
|
|
|
<main>
|
|
<h2>How can I get my project here?</h2>
|
|
<p>neoBeta is an open-source content management system. There are various ways you can put your plugin/mod on our catalog:</p>
|
|
<ul>
|
|
<li>Clone <a href="https://github.com/adrianvic/neoBeta">neoBeta's repository</a>, create your project folder inside the /projects directory with the necessary metadata (index.md for project description, index.json for metadata and any other file your project may depend on) and make a pull request. Less manual work on our side, so review should be quickier.</li>
|
|
<li>Open an issue on our GitHub repository with the project information. This may take longer as a contributor will have to spend time creating the project files, but is useful if you're not confortable using Git.</li>
|
|
<li>Host your own instance of neoBeta.</li>
|
|
</ul>
|
|
<h3>Required metadata fields</h3>
|
|
<ul>
|
|
<li><em>name</em> - project name.</li>
|
|
<li><em>subtitle</em> - project's brief description.</li>
|
|
<li><em>author</em> - your author name, must be consistent across all your submissions.</li>
|
|
<li><em>tags</em> - whether your project is a plugin or mod.</li>
|
|
</ul>
|
|
<h3>Optional metadata fields</h3>
|
|
<p>Please fill as many fields as possible.</p>
|
|
<ul>
|
|
<li><em>images</em> - lists of image files names or URLs that will appear in the project page.</li>
|
|
<li><em>logo</em> - your logo file name or URL.</li>
|
|
<li><em>gameVersions</em> - taget Minecraft versions.</li>
|
|
<li><em>gameLoaders</em> - supported modloaders.</li>
|
|
</ul>
|
|
<h3>Releases metadata</h3>
|
|
<ul>
|
|
<li><em>releasesType</em> - wheter your project uses <code>local</code> releases or <code>github</code>.</li>
|
|
</ul>
|
|
<p>For local releases:</p>
|
|
<ul>
|
|
<li><em>releases</em> - a list of relases labels and links.
|
|
<ul>
|
|
<li><em>name</em> - name of the release.</li>
|
|
<li><em>version</em> - version of the release.</li>
|
|
<li><em>gameVersions</em> - taget Minecraft versions (overrides default value).</li>
|
|
<li><em>gameLoaders</em> - supported modloaders (overrides default value).</li>
|
|
<li><em>downloads</em> - list of download links for this release.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<p>For GitHub releases:</p>
|
|
<ul>
|
|
<li><em>githubRepoOwner</em> - username of the repo owner.</li>
|
|
<li><em>githubReponame</em> - name of the repository.</li>
|
|
</ul>
|
|
<h3>Config file example</h3>
|
|
<pre><code>{
|
|
"name": "Ghosts 'n Stuff",
|
|
"subtitle": "Miscellaneous additions to your Minecraft server.",
|
|
"author": "tenkuma",
|
|
"downloadLink": "https://modrinth.com/plugin/ghosts/versions",
|
|
"images": ["anti-spam.png", "rainbow-chat.png", "skibidi-blocker.png"],
|
|
"logo": "logo.png",
|
|
"tags": ["plugin"],
|
|
"links": {
|
|
"GitHub": "https://github.com/adrianvic/ghostsandstuff",
|
|
"Disroot Git": "https://git.disroot.org/adrianvictor/ghostsandstuff"
|
|
},
|
|
"docs": {
|
|
"Installation" : "docs/installation"
|
|
},
|
|
"releaseType": "github or local",
|
|
"githubRepoOwner": "adrianvic",
|
|
"githubRepoName": "ghostsandstuff",
|
|
"gameLoaders": ["Craftbukkit"]
|
|
"releases": [
|
|
{
|
|
"name": "The first release.",
|
|
"version": "1.0.0",
|
|
"gameVersions": ["b1.7.3"],
|
|
"downloads": {
|
|
"GitHub": "https://example.com",
|
|
"Modrinth": "https://modrinth.com"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
</code></pre>
|
|
|
|
</main>
|
|
</div>
|
|
</body>
|
|
</html> |