Code Monkey home page Code Monkey logo

website's Introduction

MinecraftPlus

This repository contains a specially crafted toolkit to modify the original version of Minecraft in a way that allows multiple contributors to collaborate.

You can learn more about the project and its assumptions on minecraftplus.org.

How to start

Clone or download this repository and run:

./gradlew buildAll

or when working on Windows:

./gradlew.bat buildAll

This task will download all necessary files (tools, libraries, game assets, etc.) and decompile game. Decompiled source code will be stored inside subproject in /project directory.

Requirements

To run build script You need:

  • Java (JRE or JDK) installed (version 8 and 11 is confirmed stable)

Subproject

Is the most important part (because the changes introduced as part of the project are made in it).

Subproject stored in /project directory has it own build.gradle buildscript configuring tasks needed to compile and assemble client and server JARs.

Source code

Game source code files are stored in subproject under /src/main/java directory.

Resources

Resources used in game are stored in subproject under /src/main/resources, simultaneously keeping them in division into internal (stored in game JAR file) and remote (indexed, downloadable assets).

Running

Running game client or server implementation from source code in project is automated by gradle tasks in group mcplus run. These can be listed by command:

./gradlew tasks --group="mcplus run"

------------------------------------------------------------
Tasks runnable from root project 'minecraftplus'
------------------------------------------------------------

Mcplus run tasks
----------------
runClient - Run project client application
runServer - Run project server application

Using these tasks is useful especially in running client side - which needs to pass needed arguments from version manifest (normally prepared by game launcher).

Patches

Changes to the game code are stored inside the project in the form of patches (diff files). Patches are stored in the src/patches/ folder.

No commit history is stored with patches as in case with patches generated by git format-patch.

Generating manually

At any time, using the patchesMake task, you can generate a new set of patches based on the current state of source code in /project/src directory.

Once the patches are generated manually, they must also be manually placed in the project repository by creating a new command

Generating with SmartPatch

Manually generating patches and storing them in a repository commit can be cumbersome when storing complex changes (consisting of a set of commits).

For this purpose, the SmartPatch mechanism has been prepared, which enables the automation of generating patches along with the transfer of history from the subproject.

It consists of a set of tasks for:

  • creating the configuration of script
  • extracting the commit smart-list from the subproject repository
  • making a set of patches for each of the extracted commits
  • committing the generated patch sets to the main project, keeping the original commit message and the scope of changes made to it

Available tasks can be listed by command:

./gradlew tasks --group="mcplus smartpatch"

------------------------------------------------------------
Tasks runnable from root project 'minecraftplus'
------------------------------------------------------------

Mcplus smartpatch tasks
------------------------------
smartpatchCreateConfig - Create configuration for SmartPatch scripts
smartpatchExtractCommits - Extract commits list from the subproject repository
smartpatchMakePatches - Make sets of patches of all sourcesets in subproject, one for each commit
smartpatchCommitPatches - Commit all generated patch sets to the main project, with one commit per set

website's People

Contributors

thewituch avatar

Watchers

 avatar

website's Issues

Add multi-language support

Add/configure Pico plugin for multi-language pages.

The most important is to add an english version for each page.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.