Categorygithub.com/NeuralNexusDev/neuralnexus-apimodulesarchive
package
0.0.0-20241201040153-f200875f8601
Repository: https://github.com/neuralnexusdev/neuralnexus-api.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
9
Dependents
0
Files
409 SLOC

# README

Generalized Archive Module

Given the GPL-3.0 license, this standalone module can be freely used in compliance with the NeuralNexus API's licensing terms, as long as the user implements their own authenicaiton and authorization system that does not rely on the NeuralNexus API's authentication system. (In short, one cannot commercially use the NeuralNexus API's authentication system in a competing product, whereas self-hosting the NeuralNexus API is permitted.)

# Functions

ApplyRoutes - Apply routes to the router.
NewBukkitPlugin creates a new BukkitPlugin struct from the plugin.yml file.
NewBungeeCordPlugin creates a new BungeeCordPlugin struct from the bungee.yml/plugin.yml file.
NewFabricMod creates a new FabricMod struct from the fabric.mod.json file.
NewForgeLegacyMod creates a new ForgeLegacyMod struct from the mcmod.info file.
NewForgeMod creates a new ForgeMod struct from the mods.toml file.
NewMCMeta creates a new MCMeta struct from the pack.mcmeta file.
NewS3Store creates a new S3 store.
NewService creates a new archive service.
NewSpongePlugin creates a new SpongePlugin struct from the sponge_plugins.json file.
NewVelocityPlugin creates a new VelocityPlugin struct from the velocity-plugin.json file.

# Constants

ModPlatformBukkit is the Bukkit platform.
ModPlatformBungeeCord is the BungeeCord platform.
ModPlatformFabric is the Fabric platform.
ModPlatformForge is the Forge platform.
ModPlatformSponge is the Sponge platform.
ModPlatformVelocity is the Velocity platform.

# Structs

ArchiveItem is a struct that represents an item in the archive.
BukkitPlugin is a struct that represents the plugin.yml file of a Bukkit plugin.
BungeeCordPlugin is a struct that represents the bungee.yml/plugin.yml file of a BungeeCord plugin.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Link is a struct that represents external links.
MCMeta is a struct that represents the pack.mcmeta file.
MCMod is a struct that represents a Minecraft mod.
MCModDependency is a struct that represents a dependency of a Minecraft mod.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Interfaces

PluginMod interface for a plugin/mod that can be converted to an MCMod.
S3Store interface for an S3 store.
Service interface for the archive service.

# Type aliases

ForgeLegacyMod is a struct that represents the mcmod.info file of a Forge mod.
ModPlatform is a type that represents a platform for a Minecraft mod.