• Stars
    star
    255
  • Rank 159,729 (Top 4 %)
  • Language
    Java
  • License
    MIT License
  • Created about 10 years ago
  • Updated almost 3 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

The SpongeAPI implementation for Vanilla Minecraft.

SpongeVanilla Build Status

Currently not stable and under heavy development!

SpongeVanilla is the SpongeAPI implementation for Vanilla Minecraft.

Prerequisites

Cloning

The following steps will ensure your project is cloned properly.

  1. git clone --recursive https://github.com/SpongePowered/SpongeVanilla.git
  2. cd SpongeVanilla
  3. cp scripts/pre-commit .git/hooks

Note: If you accidentally omit --recursive option when cloning, you may delete the repository and try again, or you may execute the following to fix the situation:

git submodule update --init --recursive

Setup

Note: SpongeVanilla uses Gradle as its build system. The repo includes the Gradle wrapper that will automatically download the correct Gradle version. Local installations of Gradle may work but are untested. To execute the Gradle wrapper, run the ./gradlew script on Unix systems or only gradlew on Windows systems.

Before you are able to build SpongeVanilla, you must first prepare the environment:

  • Run ./gradlew setupDecompWorkspace --refresh-dependencies

IDE Setup

For Eclipse

  1. Run ./gradlew eclipse
  2. Import SpongeVanilla as an existing project (File > Import > General)
  3. Select the root folder for SpongeVanilla and make sure Search for nested projects is enabled
  4. Check SpongeVanilla when it finishes building and click Finish

For IntelliJ

  1. Make sure you have the Gradle plugin enabled (File > Settings > Plugins. For macOS users: IntelliJ IDEA > Preferences > Plugins).
  2. Click File > New > Project from Existing Sources > Gradle and select the root folder for SpongeVanilla.
  3. Make sure Use default gradle wrapper is selected. Older/newer Gradle versions may work but we only test using the wrapper.

Running

Note: The following is aimed to help you setup run configurations for Eclipse and IntelliJ, if you do not want to be able to run SpongeVanilla directly from your IDE then you can skip this.

For Eclipse

  1. Running ./gradlew eclipse should have generated the run configurations automatically.
  2. When launching the server for the first time, it will shutdown by itself. You will need to modify eula.txt to set eula=true (this means you agree to the Mojang EULA, if you do not wish to do this then you cannot run the server).

For IntelliJ

  1. Run ./gradlew genIntelliJRuns
  2. Restart IntelliJ IDEA or reload the project, the run configuration should now be generated.
  3. When launching the server for the first time, it will shutdown by itself. You will need to modify eula.txt to set eula=true (this means you agree to the Mojang EULA, if you do not wish to do this then you cannot run the server).

Building

Note: You must setup the environment before you can build SpongeVanilla.

In order to build SpongeVanilla you simply need to run the gradlew command. On Windows systems you should run gradlew instead of ./gradlew to invoke the Gradle wrapper. You can find the compiled JAR files in ./build/libs. You can find the compiled JAR files in ./build/libs but in most cases you'll only need 'spongevanilla-x.x.x-x.x-x.jar'.

Updating your Clone

The following steps will update your clone with the official repo.

  1. git pull
  2. git submodule update --recursive
  3. ./gradlew setupDecompWorkspace --refresh-dependencies

FAQ

A dependency was added, but my IDE is missing it! How do I add it?

If a new dependency was added, you can just restart your IDE and the Gradle plugin for that IDE should pull in the new dependencies.

Contributing

Are you a talented programmer looking to contribute some code? We'd love the help!

  • Open a pull request with your changes, following our guidelines.
  • Please follow the above guidelines for your pull request(s) to be accepted.

Help! Things are not working!

Some issues can be resolved by deleting the '.gradle' folder in your user directory and running through the setup steps again, or even running gradle cleanCache and running through the setup again. Otherwise if you are having trouble with something that the README does not cover, feel free to join our IRC channel and ask for assistance.

More Repositories

1

Mixin

Mixin is a trait/mixin and bytecode weaving framework for Java using ASM
Java
1,229
star
2

SpongeForge

A Forge mod that implements SpongeAPI
Java
1,150
star
3

SpongeAPI

A Minecraft plugin API
Java
1,127
star
4

Sponge

The SpongeAPI implementation targeting vanilla Minecraft and 3rd party platforms.
Java
360
star
5

Configurate

A simple configuration library for Java applications providing a node structure, a variety of formats, and tools for transformation
Java
310
star
6

SpongeDocs

Documentation for Sponge and its Implementations
Java
103
star
7

noise

Noise generation library for Java, based on the libnoise C++ library. It is used to generate coherent noise, a type of smoothly-changing noise. It can also generate Perlin noise, ridged multifractal noise, and other types of coherent noise.
Java
101
star
8

MixinGradle

Gradle plugin that adds the Mixin technology capability to your project.
Groovy
90
star
9

VanillaGradle

A toolchain for Minecraft: Java Edition that builds a workspace to interact with the game using the official mappings provided to the public by Mojang Studios.
Java
90
star
10

Ore

Repository software for Sponge plugins and Forge mods
Scala
75
star
11

math

Immutable math library for Java that offers easy conversion between math types, fast trigonometric functions, vectors, matrices, complex numbers, quaternions, and operation chaining, with a focus on games and computer graphics.
Java
54
star
12

nbt

Named Binary Tag (NBT) library for Java based on Graham Edgecombe's JNBT library. NBT is a tag based binary format designed to carry large amounts of binary data with smaller amounts of additional data.
Java
50
star
13

McTester

An integration testing framework for Minecraft
Java
39
star
14

Schematic-Specification

Schematic Format Specification for Minecraft
36
star
15

Cookbook

SpongeAPI munchy crunchy delicious recipes
Java
35
star
16

SpongeGradle

Handy gradle utilities for the various gradle projects of SpongePowered
Java
21
star
17

SpongeHome

A brand new homepage for SpongePowered
SCSS
15
star
18

SpongeAuth

An authentication portal for shared user accounts between Sponge services.
Python
10
star
19

sponge-docs-theme

Theme for the sponge documentation
JavaScript
8
star
20

LaunchWrapperTestSuite

A LaunchWrapper JUnit Test Suite
Java
7
star
21

OrePlugin

Package manager for the Sponge platform using the Ore web service.
Java
7
star
22

Spongie

The one and only hard working bot for Sponge!
Java
6
star
23

plugin-meta

Plugin Metadata Specification
Java
6
star
24

SystemOfADownload

Downloads webpage builder, backend builds the database and pages
Java
5
star
25

event-impl-gen

Used for generating SpongeEventFactory in SpongeAPI
Java
5
star
26

DownloadIndexer

The download indexer and API for the Sponge project
Go
4
star
27

LegacySpongeAuth

An authentication portal for shared user accounts between Sponge services.
Scala
4
star
28

sponge-plugin-template

A template for making a Sponge plugin for SpongeAPI 8.0.0
Java
3
star
29

sponge-plugin-archetype

Java
3
star
30

SpongeWebGo

Go
2
star
31

Metronome

Hax?
Java
2
star
32

APIJavadocs

HTML
2
star
33

Royale

Anaheim, CA - Minecon 2016 Exhibition showcase. Battle royale.
Java
2
star
34

collections

Uncommon data structure collections for Java 8
Java
2
star
35

gitpatcher

Groovy
2
star
36

repoindexer

Java
2
star
37

observer

Java
1
star
38

SpongeDownloads

The downloads page for the Sponge project
Vue
1
star
39

Lorenz

Java
1
star
40

plugin-spi

Plugin Loading Specification
Java
1
star