Difference between revisions of "Getting Started"

From EVEmu Wiki
Jump to navigation Jump to search
m
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Getting Started ==
+
== Getting Started (Development) ==
This page is for people who want to develop EVEmu, if you want to install EVEmu on your system, please go here.
+
Welcome! So you want to do some development work on EVEmu. Great! We can use as much help as we can get with this project. EVEmu needs as many developers as possible, even if you don't currently have the skills needed. Don't worry if you don't this guide will provide you with some resources that will help you with the knowledge gap. As always if you have any questions please contact us on our [[EVEmu Connect|discord or forums.]]
  
'''Testing:'''
+
==== Getting Prepared (Development) ====
* Learn more about [[Testing EVEmu]]
 
* [[Eve-tool]]
 
  
'''Writing Code:'''
+
* [[New Users Guide]] will help you setup the EVEmu server and client for your use.
* You need to know the C or C++ programming language to write code for EVEmu. Learn C/C++ at these locations:
+
* [[Development Practices|Development Practices Guide]] will help you understand how the EVEmu code is formatted.
** [https://cplusplus.com/ CPlusPlus.com]
+
* [[The EVEmu Guide|EVEmu Guide]] will help you understand the EVEmu Code Base and how it is structured.
 +
* [[EVEmu Database Guide]] will help you learn how EVEmu utilizes its backend MySQL database.
  
*[https://www.cprogramming.com/ CProgramming.com]
+
== Writing Code ==
*Source [[ Development Practices]] guide - check this out to see how we like contributing developers to format their code
 
*How to create and use packets in EVEmu - Check this if you don't know how them work
 
'''Packet formating:'''
 
* EveMu [[xmlpktgen]] - How to format packets in XMLP and general information about xmlpktgen.
 
  
== '''Learn about the EVEmu Codebase''' ==
+
==== Learning Resources ====
* The [[The EVEmu Guide|EVEmu Guide]] - go here to learn about the EVEmu code base and how it's structured
+
EVEmu is a learning project. Listed below are some resources that will give you a steady dive into C++ development
* The [[ EVEmu Database Guide|EVEmu Database Guide]] - go here to learn about how EVEmu uses and manages the back end MySQL database
 
  
== '''Server development''' ==
+
* [https://cplusplus.com/ CPlusPlus.com]
* [[Crucible Project Status|EVEmu Project Tracking]] - this is the list of game features and their operational status in the most recent server builds
+
* [https://www.cprogramming.com/ CProgramming.com]
* [[New Users Guide]] - Basic guide with how to get started with EVEmu and setting up the server.
+
* [https://www.learncpp.com/ LearnCPP.com]
  
== '''Installer Development''' ==
+
==== Packet Formating ====
* EVEmu Installer
+
*[[Xmlpktgen]] shows how to format packets in XMLP and general information about xmlpktgen.
  
== '''Database information''' ==
+
==== General Tools ====
* Dumps distributed with EVEmu
 
* Decoding the EVEmu MySQL Tables
 
* Database Tools - information on tools used with the EVEmu database: [[ EVEmu Control Panel]]
 
  
== '''Live information''' ==
+
* [[Eve-tool|Eve Tool]] is a collection of functions that allow us to do different things with EVE specific data.
 +
 
 +
==Getting Started (Testing)==
 +
Developers aren't all that EVEmu needs. We need testers and individuals who want to play the game.
 +
 
 +
==== Getting Prepared (Testing) ====
 +
 
 +
* [[New Users Guide]] will help you setup the EVEmu server and client for your use.
 +
 
 +
* [[Crucible Project Status|EVEmu Project Tracking]] is the list of game features and their operational status in the most recent server builds
 +
* [https://github.com/EvEmu-Project/evemu_Crucible/issues EVEmu Issues] is where you will report any issues that you find with the EVEmu Server.
 +
 
 +
== Testing ==
 +
There isn't really a definitive way that we can ask you to play test the server. The best way that has been found is to just play the game. Please take a look at the [[Crucible Project Status|EVEmu Project Tracking]] and find things that you want to test. If you find any issues with the server please open a report on our [https://github.com/EvEmu-Project/evemu_Crucible/issues Github Issues]. Please include as much information as you can about the issues that you have encountered to allow our developers to track down the issue.
 +
 
 +
==== Testing Steps ====
 +
 
 +
* Install the Client and Server via the [[New Users Guide]]
 +
* Play around and experiment on the server
 +
* Report any issues on EVEmu's [https://github.com/EvEmu-Project/evemu_Crucible/issues Github Issues].

Latest revision as of 15:04, 5 April 2021

Getting Started (Development)

Welcome! So you want to do some development work on EVEmu. Great! We can use as much help as we can get with this project. EVEmu needs as many developers as possible, even if you don't currently have the skills needed. Don't worry if you don't this guide will provide you with some resources that will help you with the knowledge gap. As always if you have any questions please contact us on our discord or forums.

Getting Prepared (Development)

Writing Code

Learning Resources

EVEmu is a learning project. Listed below are some resources that will give you a steady dive into C++ development

Packet Formating

  • Xmlpktgen shows how to format packets in XMLP and general information about xmlpktgen.

General Tools

  • Eve Tool is a collection of functions that allow us to do different things with EVE specific data.

Getting Started (Testing)

Developers aren't all that EVEmu needs. We need testers and individuals who want to play the game.

Getting Prepared (Testing)

  • New Users Guide will help you setup the EVEmu server and client for your use.
  • EVEmu Project Tracking is the list of game features and their operational status in the most recent server builds
  • EVEmu Issues is where you will report any issues that you find with the EVEmu Server.

Testing

There isn't really a definitive way that we can ask you to play test the server. The best way that has been found is to just play the game. Please take a look at the EVEmu Project Tracking and find things that you want to test. If you find any issues with the server please open a report on our Github Issues. Please include as much information as you can about the issues that you have encountered to allow our developers to track down the issue.

Testing Steps