Skip to content

Commit a6e46c7

Browse files
committed
added README.md
1 parent 042dd6c commit a6e46c7

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

README.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
![N|Solid](https://mamen.at/ugamela/images/logo.png)
2+
3+
![N|solid](http://raspinoip.ddns.net:60023/job/ugamela/badge/icon)
4+
5+
# What is ugamela?
6+
7+
ugamela is a open-source clone of the popular browsergame ogame, developed by the Gameforge 4D GmbH. It first appeared around the year 2006, when Peberos published the source-code for his version of ugamela. It stayed open-source until the version 0.2-r13, which can still be found for download. After this, Peberos continued to improve ugamela as a closed-source browsergame.
8+
9+
Now, many years later, ugamela is back, redone completely from scratch with the latest web-technologies available. Its goal is to be as close to the original ogame (also known as ogame classic) as possible.
10+
11+
# Disclaimer
12+
13+
This open-source project is still in an alpha-state, **please do not use this in an production-environment**. Currently, not many features are available and this game is not fully playable. Feel free to contribute by making a pull-request.
14+
15+
# Project-Structure
16+
17+
```shell
18+
├── core/ # → contains all necessary classes
19+
│ └── classes/ # → classes for the ORM-Mapping and parent-classes
20+
│ └── controllers/ # → all needed controller-classes
21+
│ └── interfaces/ # → interfaces the classes
22+
│ └── language/ # → contains all translations in subfolders named after their ISO 639-1 language-code
23+
│ └── models/ # → all needed model-classes
24+
│ └── templates/ # → template for each site (HTML)
25+
│ └── views/ # → all needed view-classes
26+
├── css/ # → css for all pages outside of the game
27+
├── images/ # → images for all pages outside of the game
28+
├── install/ # → contains the necessary files for a first-time setup
29+
├── scripts/ # → javascripts
30+
├── skins/ # → skins, which are useable ingame (all images and css for the game must go here)
31+
├── game.php # → the main php-file, which dynamically loads the needed pages
32+
├── index.php # → redirects to the game.php if logged in, else to the login-page
33+
└── login.php # → login-form for the user
34+
```
35+
36+
# Quick Start
37+
38+
1. This project uses is being developed with the (currently) latest release of PHP (Version 7.1.9) and mariaDB (Version 10.2). For a easy quick start, use the latest release of [XAMPP](https://www.apachefriends.org/de/download.html) or use [Docker](https://www.docker.com) with the necessary containers.
39+
2. After setting up your environment, import the sql-file located in the install directory.
40+
3. Edit the config.php in the core-folder to match your server-configuration.
41+
4. Login to the game with the **default Username** "admin" and **default Password** "admin"
42+
43+
# Support / Questions
44+
45+
For any further questions, support or general talk, please visit our Discord by clicking on the image below or follow the link.
46+
47+
[![N|Solid](https://t5.rbxcdn.com/18108a5641ff1becc8dfa20aed634d1f)](https://discord.gg/WPApmAX)
48+
49+
https://discord.gg/WPApmAX

0 commit comments

Comments
 (0)