Mirror/TrinityCore
1
0
Fork 0
mirror of https://github.com/TrinityCore/TrinityCore.git synced 2026-01-15 23:20:36 +01:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Prettify README

Browse Source 
Thanks to Guybrush for the help
This commit is contained in:
Nay
2013-07-28 21:17:32 +01:00
parent 3330239a02
commit 4559e99e0d
2 changed files with 80 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
README
View File

@@ -1,80 +0,0 @@
= TrinityCore -- General information =
Copyright (C) TrinityCore (http://www.trinitycore.org)
Trinity Core is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
In addition, as a special exception, the Trinity Core project
gives permission to link the code of its release of Trinity Core with
the OpenSSL project's "OpenSSL" library (or with modified versions of
it that use the same license as the "OpenSSL" library), and distribute
the linked executables. You must obey the GNU General Public License
in all respects for all of the code used other than "OpenSSL". If you
modify this file, you may extend this exception to your version of the
file, but you are not obligated to do so. If you do not wish to do
so, delete this exception statement from your version.
TrinityCore is a MMORPG Framework based mostly on C++. It is completely
open source, and is community supported. It is derived
from MaNGOS, the Massive Network Game Object Server, and is based on the
code of that project with extensive changes over time to optimize, improve
and cleanup the codebase at the same time as improving the ingame mechanics
and functionality. If you wish to contribute ideas or code please visit
our site linked below or make pull requests to our github repo at
https://github.com/TrinityCore/TrinityCore
For further information on the TrinityCore project, please visit our
project website at http://www.TrinityCore.org
Documentation including installation instructions can be found inside
the doc directory.
SQL files to create the databases can be found in the sql/create and
sql/base directories.
You need to run sql/create/create_mysql.sql 1st and then
sql/base/auth_database.sql and sql/base/characters_database.sql
You need to download world database from http://www.trinitycore.org/f/files/
be sure you get the higher numbered database.
When installing a core the 1st time you need to import also all the files at
sql/updates/world directory.
sql/updates/auth and sql/updates/characters databases only needs to be run
when updating one existing server.
To save time importing multiple files, you can use copy *.sql world_updates.sql
under Windows or cat *.sql > world_updates under Linux.
You need to update your core (recompile and overwrite binaries) when updating
your database, usually you can't use one older core with a newer database or a
newer core with an older database.
When updating your core you also need to import the files at sql/updates/auth
and sql/updates/characters along with the sql/updates/world files.
You can't merge all the sql files on sql/updates into a single file, because
they belong to 3 different databases and they don't use database name.
TrinityCore Requirements
Platform: Linux, Windows or Mac
Processor with SSE2 support
ACE ≥ 5.8.3
MySQL ≥ 5.1.0
CMake ≥ 2.8.0
OpenSSL ≥ 0.9.8o
GCC ≥ 4.3 (Linux only)
MS Visual Studio ≥ 9 (2008) (Windows only)
A bit of brain, wiki can become outdated with the release of new TDB versions
if wiki refers to TDB 50 and you see TDB 52 get the higher number.
Some reading skills, search forum, read http://www.trinitycore.org/f/topic/1518-
and http://www.trinitycore.org/f/topic/37- before posting a bug report or ask for
help on forum.
Search for existing bug reports before posting your own bug reports; don't post multiple
bugs on a single ticket.

80
README.md Normal file
View File

@@ -0,0 +1,80 @@
# ![logo](http://www.trinitycore.org/f/public/style_images/1_trinitycore.png) TrinityCore
## Introduction
TrinityCore is a *MMORPG* Framework based mostly in C++.
It is derived from *MaNGOS*, the *Massive Network Game Object Server*, and is
based on the code of that project with extensive changes over time to optimize,
improve and cleanup the codebase at the same time as improving the in-game
mechanics and functionality.
It is completely open source; community involvement is highly encouraged.
If you wish to contribute ideas or code please visit our site linked below or
make pull requests to our [Github repository](https://github.com/TrinityCore/TrinityCore).
For further information on the TrinityCore project, please visit our project
website at [TrinityCore.org](http://www.trinitycore.org).
## Requirements
+ Platform: Linux, Windows or Mac
+ Processor with SSE2 support
+ ACE ≥ 5.8.3 (included for Windows)
+ MySQL ≥ 5.1.0 (included for Windows)
+ CMake ≥ 2.8.0
+ OpenSSL ≥ 0.9.8o
+ GCC ≥ 4.3 (Linux only)
+ MS Visual Studio ≥ 9 (2008) (Windows only)
## Install
Detailed installation guides are available in the wiki for
[Windows](http://collab.kpsn.org/display/tc/How-to_Win),
[Linux](http://collab.kpsn.org/display/tc/How-to_Linux) and
[Mac OSX](http://collab.kpsn.org/display/tc/How-to_Mac).
## Reporting issues
Issues can be reported via the [Github issue tracker](https://github.com/TrinityCore/TrinityCore/issues?labels=Branch-3.3.5a).
Please take the time to review existing issues before submitting your own to
prevent duplicates.
In addition, thoroughly read through the [issue tracker guide](http://www.trinitycore.org/f/topic/37-the-trinitycore-issuetracker-and-you/) to ensure
your report contains the required information. Incorrect or poorly formed
reports are wasteful and are subject to deletion.
## Submitting fixes
Fixes are submitted as pull requests via Github. For more information on how to
properly submit a pull request, read the [how-to: maintain a remote fork](http://www.trinitycore.org/f/topic/6037-howto-maintain-a-remote-fork-for-pull-requests-tortoisegit/).
## Copyright
License: GPL 2.0
Read file [COPYING](COPYING)
## Authors & Contributors
Read file [THANKS](THANKS)
## Links
[Site](http://www.trinitycore.org)
[Wiki](http://trinitycore.info)
[Documentation](http://www.trinitycore.net) (powered by Doxygen)
[Forums](http://www.trinitycore.org/f/)