Skip to content

Latest commit

 

History

History
76 lines (58 loc) · 5.09 KB

README.md

File metadata and controls

76 lines (58 loc) · 5.09 KB
Raw

The Kabal Invasion

The Kabal Invasion is a web-based 4X space game. It is coded in PHP/HTML/JS/SQL.

PHP8 ready GitHub license Codacy Badge CII Best Practices GitHub stars GitHub issues Scrutinizer Code Quality SymfonyInsight Powered by HTML Purifier

What is it?

A web based space exploration (4x) game based on the old BBS door games that went
by many names (Tradewars, Galactic Warzone, Ultimate Universe, and
many other games like this) but shares no code with them.  It is
written 100% in PHP/HTML/JS/SQL.

Why should I run this?

Web-based games that recreate the door game BBS experience can be fun!
Since it is Free and open source software, anyone can examine, learn, and contribute.

Is this game ready to install and play?

At the moment, we've identified a number of release-blocking issues including broken
password management, user sign-up, and issues with non-functional database calls. Serious
effort is underway to fix all of these issues, and we are working towards a release. In the meantime,
curious developers are encouraged to download, install, and play as the admin user to find issues
and report them. When we get to a point where the game is stable for players,
we will make an announcement, change this note, and release!

License: Affero GPL v 3

Credits:

The Kabal Invasion forked from Blacknova Traders, please visit their sourceforge page for more information about their project. We proudly stand on the shoulders of giants, with BNT originally having hundreds of developers, players, and admins. We honor and appreciate their 15+ year contribution that makes our project possible.

Requirements:

Server (generally, the most recent/current version of each is our recommendation, but these should suffice):

  • A Linux server. Our primary development platform is Fedora, but most Linux distributions should work, and potentially even OpenBSD.
  • A webserver capable of TLS such as apache v2.4+ (we have not determined a required minimum).
  • php v8.
  • mariadb v5.5+ or v10.0+ (needed for utf8mb4 schemas).
  • pdo PHP extension.

Web:

  • Chrome v92+ or Firefox v92+ (recommended).
  • Safari v15+.

Notes:

  • TKI will likely run on lighttpd and nginx, however htaccess will not work out of the box - potentially causing security risks. It has not been tested on either.
  • IIS and Windows is NOT supported, please do not ask! (But we welcome code to make it work on either)
  • Development "Snapshots" are intended only for developers that are actively involved in the development process, and require additional effort to work (composer, etc).
  • We make use of Smarty templates, HTML Purifier, Swiftmailer, and Adodb (although we are working to replace adodb with PDO).

Installation:

Please see the /docs/install.md file.

Upgrades:

As is typical with our releases, we highly recommend a fresh install. Upgrades are not supported at this time.

Code quality:

The project began in the pre-PHP4 era, and as a result, is less than ideal. Substantial progress has been made towards modernization, and we are continuing that process. As a general guideline, we follow PSR-1,2,4, and the upcoming 12, with the major exceptions that we use BSD/Allman brace/brackets and do not yet follow line length limits. Feedback and PR's are welcome and appreciated.

Critical needs:

The two areas we need the most focus in would be the documentation, and testing. Both can be done with little or no knowledge of PHP, and would help us dramatically.

Security issue reporting:

Please report all security issues to [email protected].

Contributing:

Feel free to contribute to the project! We use Gitlab for our issues tracking (provide feedback!), milestone planning, code storage, and releases.

I hope you enjoy the game!
The Kabal