Datei suchen

Travis Watkins 6149fc3e78 Don't thread single chunk compression. Fixes BUKKIT-2927 Packet 51 is used to send updates about large changes to single chunks and to remove chunks from the client when they get out of range. In the first case a single packet object is created and queued for all relevant players. With our current chunk compression scheme this means the first player to have the packet processed will start the compression and get the packet correctly but the rest will get garbage. Since this packet never contains much data it is better to simply handle compression of it on the main thread like vanilla does instead of putting in locks and dealing with their overhead and complexity.		2012-11-15 16:09:21 -06:00
src	Don't thread single chunk compression. Fixes BUKKIT-2927	2012-11-15 16:09:21 -06:00
.gitignore	Ignore minecraft resources in src directory	2011-11-29 21:20:14 +11:00
LGPL.txt	We're LGPL.	2011-01-02 10:58:11 +01:00
LICENCE.txt	We're LGPL.	2011-01-02 10:58:11 +01:00
pom.xml	Update CraftBukkit to Minecraft 1.4.4.	2012-11-13 16:09:52 -06:00
README.md	Updated README.md with more coding and pull request conventions and tips to get your pull request accepted.	2012-02-24 00:09:53 -05:00

README.md

CraftBukkit

A Bukkit (Minecraft Server API) implementation

Website: http://bukkit.org
Bugs/Suggestions: http://leaky.bukkit.org

Compilation

We use maven to handle our dependencies.

Install Maven 3
Check out and install Bukkit
- Note: this is not needed as the repository we use has Bukkit too, but you might have a newer one (with your own changes :D)
Check out this repo and: mvn clean package

Coding and Pull Request Conventions

We generally follow the Sun/Oracle coding standards.
No tabs; use 4 spaces instead.
No trailing whitespaces.
No CRLF line endings, LF only, put your gits 'core.autocrlf' on 'true'.
No 80 column limit or 'weird' midstatement newlines.
The number of commits in a pull request should be kept to a minimum (squish them into one most of the time - use common sense!).
No merges should be included in pull requests unless the pull request's purpose is a merge.
Pull requests should be tested (does it compile? AND does it work?) before submission.
Any major additions should have documentation ready and provided if applicable (this is usually the case).
Most pull requests should be accompanied by a corresponding Leaky ticket so we can associate commits with Leaky issues (this is primarily for changelog generation on dl.bukkit.org).
Try to follow test driven development where applicable.

If you make changes or add net.minecraft.server classes it is mandatory to:

Get the files from the mc-dev repo - make sure you have the last version!
Make a separate commit adding the new net.minecraft.server classes (commit message: "Added x for diff visibility" or so).
Then make further commits with your changes.
Mark your changes with:
- 1 line; add a trailing: // CraftBukkit [- Optional reason]
- 2+ lines; add
  - Before: // CraftBukkit start [- Optional comment]
  - After: // CraftBukkit end
Keep the diffs to a minimum (really important)

Tips to get your pull request accepted

Making sure you follow the above conventions is important, but just the beginning. Follow these tips to better the chances of your pull request being accepted and pulled.

Make sure you follow all of our conventions to the letter.
Make sure your code compiles under Java 5.
Provide proper JavaDocs where appropriate.
Provide proper accompanying documentation where appropriate.
Test your code.
Make sure to follow coding best practises.
Provide a test plugin binary and source for us to test your code with.
Your pull request should link to accompanying pull requests.
The description of your pull request should provide detailed information on the pull along with justification of the changes where applicable.