Difference between revisions of "Main Page"

From wiki.vg
Jump to navigation Jump to search
m (Minor cleanup of main page links and text (no _'s in links, phrasing, add PAaaS since b.wiki.vg isn't updated anymore))
(36 intermediate revisions by 18 users not shown)
Line 1: Line 1:
__NOTOC__
+
__NOTOC____NOEDITSECTION__
Welcome to the Minecraft Coalition wiki! Thanks to the #mcdevs community on irc.freenode.net.
+
{{Box|
 
+
BORDER = #9999FF|
'''As spam prevention, you must register and confirm your email address to edit pages.'''
+
BACKGROUND = #99CCFF|
 
+
WIDTH = 100%|
Consult the [http://meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.
+
ICON = |
 
+
HEADING = Minecraft Modern |
== Start Here ==
+
CONTENT =
===I want to write my own XYZ program, where do I start?===
 
Custom Minecraft development is non-trivial and is not something to cut your teeth on with respect to programming.  If you cannot answer the above question, you will likely not have a very fun time.  You will also upset other people if you ask questions that demonstrate a lack of prerequisite knowledge, especially related to general software development strategy or use of the language of your choice.
 
 
 
Likewise, the Minecraft protocol and official client/server are widely criticized in both design and implementation.  Dealing with these issues can be painful.  Worst of all, if you don't have a solid development background you may unknowingly absorb these flaws into your own development strategy - both now and down the line on future projects.
 
 
 
In closing, first see if there is an existing project that you can contribute to.  There are already a variety of mods, clients, servers, utilities and libraries that could use help - and not just related to coding.
 
 
 
===The wiki is WRONG!!!===
 
Are you 100% certain, and do you have a testcase to prove your assertion?
 
 
 
If not, many people have implemented projects using the information here and chances are you're doing something wrong.
 
 
 
If so, by making use of this site, you owe it to the community to contribute fixes and documentation enhancements back.
 
 
 
Remember, this wiki is a volunteer effort.  Treat the people who contribute to it with respect.
 
 
 
Also, the wiki is out of date a lot.  Check "Recent changes" and "Discussion" pages for more info.
 
 
 
== Modern ==
 
 
[[File:Banner beta.png|link=Category:Minecraft Modern]]
 
[[File:Banner beta.png|link=Category:Minecraft Modern]]
  
Line 31: Line 12:
  
 
=== Documentation ===
 
=== Documentation ===
There are ongoing efforts to keep reverse engineered documentation updated, but it isn't as easy as it sounds. The protocol generally changes with each release, and both the Client and Server classes get rearranged on each release. Below are links to the current documentation segments, which '''may or may not be accurate'''.
+
There are ongoing efforts to keep reverse engineered documentation updated, but it isn't as easy as it sounds. The protocol generally changes slightly with each release, and both the Client and Server classes get rearranged on each release. Below are links to the current documentation segments, which '''may or may not be completely up to date'''.
* [[Protocol|Protocol Spec]]
+
 
* [[Pre-release protocol|Pre-release Protocol Spec]]
 
* [[Rcon]] and [[Query]] protocols
 
* [[Chat|How Chat Works]]
 
 
* [[Protocol FAQ]]
 
* [[Protocol FAQ]]
 +
* [[Protocol|Current Protocol Specification]]
 +
** [[Protocol Encryption]]
 +
** [[Server List Ping]] documentation
 +
** [[Protocol version numbers]]
 +
** [[Plugin channels]]
 +
* [[Pre-release protocol|Pre-release Protocol Specificaton]]
 
* [[Authentication|Authentication Scheme]]
 
* [[Authentication|Authentication Scheme]]
 +
* [[Mojang API]]
 +
* [[Game Files|Location of Game Files]]
 
* [[Map Format]] (See also: mirror of the old [[NBT]].txt)
 
* [[Map Format]] (See also: mirror of the old [[NBT]].txt)
* [http://b.wiki.vg/ Burger Vitrine] shows differences in data and protocol between arbitrary versions.
+
* [[Snoop|Snoop Mechanism]]
 +
* [[Realms API]]
 +
* [[Rcon]] and [[Query]] protocol specifications
 +
* [[Debugging]]
  
=== Source Code & Snippets ===
+
=== Tools & Mods ===
Source code snippets provide insight into how specific features work or can be accomplished, and by themselves are generally free to use in your own program.
 
* [http://w.tkte.ch/doku.php/minecraft/skin_previews PHP and Python scripts] to generate images & GIFs from minecraft skins.
 
* [[Chunk_data_decompressing_(Zlib)|Chunk data decompressing using Zlib]], a small snippet showing how to use Zlib to decompress the chunk data sent by 0x33 packets.
 
* [[:Code Snippets|More...]]
 
 
 
=== Tools and Mods ===
 
 
* [[Client List|Clients]] - third-party Minecraft clients.
 
* [[Client List|Clients]] - third-party Minecraft clients.
 
* [[Server List|Servers]] - third-party Minecraft servers.
 
* [[Server List|Servers]] - third-party Minecraft servers.
Line 53: Line 36:
 
* [[Utility List|Utilities]] - tools that interface with a client, server, or data files, such as proxies, bots, or inventory editors.
 
* [[Utility List|Utilities]] - tools that interface with a client, server, or data files, such as proxies, bots, or inventory editors.
 
* [[Wrapper List|Wrappers]] - mods that override features in the client or server
 
* [[Wrapper List|Wrappers]] - mods that override features in the client or server
 +
* [https://github.com/mcdevs/Burger/ Burger] - a tool that generates information for arbitrary Minecraft versions
 +
:* [http://b.wiki.vg/ Burger Vitrine] - shows differences in data and protocol between arbitrary versions (prior to 1.7).
 +
:* [https://matsv.nl/PAaaS/ PAaaS] - shows differences in protocol and sounds for newer versions (1.8 and above)
 +
* [[Code Snippets]]
  
=== Tutorials ===
+
=== Tutorials & Guides ===
 
* [[How to Write a Client]]
 
* [[How to Write a Client]]
 +
* [[How to Write a Server]]
 +
* [[Chat|How Chat Works]]
  
 
For more info, check out [[:Category:Minecraft Modern|Minecraft Modern]].
 
For more info, check out [[:Category:Minecraft Modern|Minecraft Modern]].
 +
}}
  
== Classic ==
+
{{Box|
 +
BORDER = #9999FF|
 +
BACKGROUND = #99CCFF|
 +
WIDTH = 100%|
 +
ICON = |
 +
HEADING = Minecraft Classic |
 +
CONTENT =
 
[[File:Banner classic.png|link=Category:Minecraft Classic]]
 
[[File:Banner classic.png|link=Category:Minecraft Classic]]
  
Line 67: Line 63:
 
As there is no longer any work being done on classic, the documentation for it is stable. If you create something that works with it, it probably always will.
 
As there is no longer any work being done on classic, the documentation for it is stable. If you create something that works with it, it probably always will.
 
* [[Classic Protocol|Protocol Specification]]
 
* [[Classic Protocol|Protocol Specification]]
 +
* [[Classic Protocol Extension|Extension Protocol Specification]]
 
* [[Classic DAT Format|Server Map Format (.dat)]]
 
* [[Classic DAT Format|Server Map Format (.dat)]]
 
* [[MCLevel Format|Saved Level Format (.mclevel)]]
 
* [[MCLevel Format|Saved Level Format (.mclevel)]]
Line 72: Line 69:
 
=== Source Code Snippets ===
 
=== Source Code Snippets ===
 
Source code snippets provide insight into how specific features work or can be accomplished, and by themselves are generally free to use in your own program.
 
Source code snippets provide insight into how specific features work or can be accomplished, and by themselves are generally free to use in your own program.
* Deserializing the level.dat file format ([[deserialize.c|C]], [[deserialize.cs|C#]])
+
* Deserializing the level.dat file format ([[deserialize.c|C]], [https://gist.github.com/324122945a569a513bae C#])
* [[Skins.php]], a script to generate a preview image from a Minecraft skin file (PHP).
 
 
* [[:Category:Code Snippets|More...]]
 
* [[:Category:Code Snippets|More...]]
  
Line 84: Line 80:
 
* [[Classic Wrapper List|Wrappers]] - mods that override features in the client or server.
 
* [[Classic Wrapper List|Wrappers]] - mods that override features in the client or server.
  
 +
For more info, check out [[:Category:Minecraft Classic|Minecraft Classic]].
 +
}}
 +
 +
{{Box|
 +
BORDER = #9999FF|
 +
BACKGROUND = #99CCFF|
 +
WIDTH = 100%|
 +
ICON = |
 +
HEADING = Minecraft Pocket Edition |
 +
CONTENT = 
 +
[[File:Banner pocket.png|link=Category:Pocket Minecraft]]
 +
 +
Minecraft Pocket Edition is the version of Minecraft for portable systems such as Android, iOS or Windows 10 devices.
 +
 +
=== Documentation ===
 +
The protocol and map format documentation for Minecraft Pocket Edition.
 +
* [[Pocket Minecraft Protocol|Old Protocol Specification]] (This protocol information is considered outdated, but still contains useful information)
 +
* [[Pocket Edition Protocol Documentation|The current Protocol docs]]
 +
* [[Pocket Edition FAQ|FAQ]]
 +
* [[Pocket Edition Login|Login Procedure]]
 +
* [[Pocket Realms|Pocket Realms]]
 +
* [[Pocket Minecraft Map Format|Map Format]]
 +
 +
=== Tools ===
 +
Useful information & links
 +
* [[Pocket Edition Program List|Program list]] - third-party PE programs
  
For more info, check out [[:Category:Minecraft Classic|Minecraft Classic]].
+
For more info, check out [[:Category:Pocket Minecraft|Pocket Minecraft]].
  
== Other Locally Hosted Resources ==
+
}}
If you need hosting or mirroring, drop the [[User:Kev009|hostmaster]] a note.
 
* [http://mc.kev009.com/libevent/ libevent2 doxygen, up to date]
 
* [http://mc.kev009.com/nbt/ NBT test files (archived)]
 
* [[Craftd:Main_Page|craftd Minecraft Server]]
 
* [[Realcraft:Main_Page|Realcraft Minecraft Server]]
 

Revision as of 00:37, 20 November 2016

Minecraft Modern

Banner beta.png

Minecraft Modern is the latest (and only updated) version of Minecraft which requires a paid account to download, update and play. Most of the new development projects focus on either creating entirely new programs from scratch that interoperate with Minecraft (such as a bot or server) or modding projects that wrap the client or server and provide bug fixes, new features and enhancements to existing features.

Documentation

There are ongoing efforts to keep reverse engineered documentation updated, but it isn't as easy as it sounds. The protocol generally changes slightly with each release, and both the Client and Server classes get rearranged on each release. Below are links to the current documentation segments, which may or may not be completely up to date.

Tools & Mods

  • Clients - third-party Minecraft clients.
  • Servers - third-party Minecraft servers.
  • Libraries - libraries to interface with Minecraft data files or network protocols.
  • Utilities - tools that interface with a client, server, or data files, such as proxies, bots, or inventory editors.
  • Wrappers - mods that override features in the client or server
  • Burger - a tool that generates information for arbitrary Minecraft versions
  • Burger Vitrine - shows differences in data and protocol between arbitrary versions (prior to 1.7).
  • PAaaS - shows differences in protocol and sounds for newer versions (1.8 and above)

Tutorials & Guides

For more info, check out Minecraft Modern.

Minecraft Classic

Banner classic.png

Minecraft Classic is the original version of Minecraft, available for free to the public. It's still available off of the main website today and is still played by many people, with an active development community. As it's been around since 2010, and because it's so simplistic, there are many, many programs made to work with Classic - there are over 18+ servers alone, written in everything from C++ to PureBasic to Perl. It's highly recommend if you're planning to do a development project at this point to instead look into the Minecraft Modern specifications.

Documentation

As there is no longer any work being done on classic, the documentation for it is stable. If you create something that works with it, it probably always will.

Source Code Snippets

Source code snippets provide insight into how specific features work or can be accomplished, and by themselves are generally free to use in your own program.

  • Deserializing the level.dat file format (C, C#)
  • More...

Tools and Mods

Useful information & links

  • Clients - third-party Classic clients.
  • Servers - third-party Classic servers.
  • Libraries - libraries to interface with Minecraft data files or network protocols.
  • Utilities - tools that interface with a client, server, or data files, such as proxies or bots.
  • Wrappers - mods that override features in the client or server.

For more info, check out Minecraft Classic.

Minecraft Pocket Edition

Banner pocket.png

Minecraft Pocket Edition is the version of Minecraft for portable systems such as Android, iOS or Windows 10 devices.

Documentation

The protocol and map format documentation for Minecraft Pocket Edition.

Tools

Useful information & links

For more info, check out Pocket Minecraft.