Skip to content

Commit

Permalink
#565 improves install instructions
Browse files Browse the repository at this point in the history
Co-Authored-By: Bigtieger <5638555+bigtieger@users.noreply.github.com>
  • Loading branch information
LucasKovacs and Bigtieger committed Sep 1, 2024
1 parent 14cce05 commit 0388703
Showing 1 changed file with 27 additions and 14 deletions.
41 changes: 27 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@



<p align="center"
<a href="https://www.xgproyect.org/" target="_blank">
<img align="center" img src="https://xgproyect.org/wp-content/uploads/2019/10/xgp-new-logo-black.png" width="250px" title="XG Proyect" alt="xgp-logo">
Expand All @@ -8,37 +9,40 @@
<strong>X</strong>treme <strong>G</strong>amez <strong>Proyect</strong>o
<br>
<strong>Open-source OGame Clon</strong>
</p>
</p>

About
====

XG Proyect (XGP) is an OGame clone open-source web application framework designed for creating game clones, particularly those inspired by the popular game OGame, set in a vast and captivating space-themed universe. Our goal is to offer a package that is as similar as possible to the original, but keeping their original design.


Official Website: https://www.xgproyect.org/
Live Server: https://www.xgproyect.net/

## Requirements

PHP 7.4 or greater
MySQLi 5.7 or greater
PHP 7.4 or greater
MySQLi 5.7 or greater

## How to get XG Proyect?

### Manually
This is the simplest and easiest way if you're not a technical person. Download and install XG Proyect will be easy! ;)

- Go to the releases section and get the latest stable release, and simply download it. It is the file `.zip` then you can do whatever you want with that package, use it on your local stack, hosting or even docker!
1. Go to [releases](https://github.com/XGProyect/XG-Proyect-v3.x.x/releases)
2. Look for the last version and then **assets** and finally look for the `.zip` file.
3. Unzip the file, you'll see 2 files and 1 folder.
4. Look for the contents of the `upload` folder, only what's inside this one is needed.
5. Copy the contents of the `upload` folder to the root on your host. There are hidden files in it, be sure that those are copied over also, specially the `.htaccess` file.
6. Make sure that PHP can write to the dir `config` for the new config File.
7. If you did everything correct, when you open the site, you'll be taken to the `install/` directory, if not try under `public/install`.
8. Using docker, XAMPP or any local stack that you want set the copies files to your root.

### Composer
Choose this option if you want to contribute to the project.

Composer which will get you everything, including docker and would install the test dependencies like PHPUnit.
Composer is a package manager and also a quick way to setup your project.

1. Run
```
composer create-project xgproyect/xgproyect
```
2. Once composer has finishing installing all the dependencies you can use docker, see below.

## How to run XG Proyect?
### Docker
Expand All @@ -63,15 +67,24 @@ Simple change the **PHP version** to any other **version** that you'd like to te
### Other ways
- Other options are also possible like XAMPP, or using it on your own hosting.

### DB Connect defaults
```
host=db
user=root
password=root
db=xgp
prefix=xgp_
```

## MailHog
XGP uses MailHog and PHPMailer as tools for better mailing support. MailHog allows you to intercept emails **locally** and receive them under a convenient panel.

Read our <a href="https://github.com/XGProyect/XG-Proyect-v3.x.x/wiki/MailHog-usage-and-setup" target="_blank">MailHog guide</a> to get started.

## Who is using XG Proyect?
We are happy to deliver this software giving others the possibility to have a good OGame Clon.
On the other hand, it's a pleasure to see people using XG Proyect.
<a href="https://github.com/XGProyect/XG-Proyect-v3.x.x/issues" target="_blank">Create a ticket</a> on GitHub so I can put your game logo here!
We are happy to deliver this software giving others the possibility to have a good OGame Clon.
On the other hand, it's a pleasure to see people using XG Proyect.
<a href="https://github.com/XGProyect/XG-Proyect-v3.x.x/issues" target="_blank">Create a ticket</a> on GitHub so I can put your game logo here!

<img align="center" img src="https://xgproyect.org/wp-content/uploads/2019/10/xgp-new-logo-black.png" width="150px" title="XG Proyect" alt="xgp-logo">

Expand Down

0 comments on commit 0388703

Please sign in to comment.