Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AppOfficer committed Nov 16, 2024
1 parent 8dec90c commit 5f897f8
Showing 1 changed file with 78 additions and 2 deletions.
80 changes: 78 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,79 @@
## LocalGen-new
<div align="center">
<h1>Local Generals.io
<br/>
<img alt="GitHub Created At" src="https://img.shields.io/github/created-at/SZXC-WG/LocalGen-new" />
<a href="https://github.com/SZXC-WG/LocalGen-new/stargazers">
<img alt="GitHub stars" src="https://img.shields.io/github/stars/SZXC-WG/LocalGen-new.svg?style=social"/>
</a>
</h1>
<img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/SZXC-WG/LocalGen-new" />
<a href="https://github.com/SZXC-WG/LocalGen-new/commits">
<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/t/SZXC-WG/LocalGen-new?label=total%20commits" />
</a>
<a href="https://github.com/SZXC-WG/LocalGen-new/contributors">
<img alt="GitHub contributors" src="https://img.shields.io/github/contributors/SZXC-WG/LocalGen-new" />
</a>
<br/>
<img alt="GitHub language count" src="https://img.shields.io/github/languages/count/SZXC-WG/LocalGen-new" />
<img alt="GitHub top language" src="https://img.shields.io/github/languages/top/SZXC-WG/LocalGen-new" />
<a href="https://github.com/SZXC-WG/LocalGen-new/blob/master/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/SZXC-WG/LocalGen-new.svg" />
</a>
<br/>
<img alt="GitHub Downloads (all assets, all releases)" src="https://img.shields.io/github/downloads/SZXC-WG/LocalGen-new/total" />
<img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/SZXC-WG/LocalGen-new"/>
<img alt="GitHub repo file or directory count" src="https://img.shields.io/github/directory-file-count/SZXC-WG/LocalGen-new" />
<br/>
<a href="https://github.com/SZXC-WG/LocalGen-new/releases/latest">
<img alt="GitHub Release" src="https://img.shields.io/github/v/release/SZXC-WG/LocalGen-new?label=latest%20stable" />
<img alt="GitHub Release Date" src="https://img.shields.io/github/release-date/SZXC-WG/LocalGen-new?label=date" />
</a>
<br/>
<a href="https://github.com/SZXC-WG/LocalGen-new/releases">
<img alt="GitHub Pre-Release" src="https://img.shields.io/github/v/release/SZXC-WG/LocalGen-new?include_prereleases&label=latest%20preview" />
<img alt="GitHub Pre-Release Date" src="https://img.shields.io/github/release-date-pre/SZXC-WG/LocalGen-new?label=date" />
</a>
</div>

This is the development branch of version 6. Please visit the [v5.0](https://github.com/SZXC-WG/LocalGen-new/tree/v5.0) branch for the v5 source code or the [releases](https://github.com/SZXC-WG/LocalGen-new/releases) page for older built versions.
## Intro

Welcome to the project of Local Generals.io (LocalGen)!

Here you can play [generals.io](http://generals.io) **completely offline**!

Enjoy playing with **out-of-the-box** robots or your friends (same LAN)!

Interested? Download LocalGen on [the release page](http://github.com/SZXC-WG/LocalGen-new/releases).

New idea? Old bugs? Contribute to the project! Simply **create an issue or a pull request**, and we'll reach out to you soon.

## [Releases (Changelog)](http://github.com/SZXC-WG/LocalGen-new/releases)

## Weak robots! Write a new one?

Certainly! We appreciate any form of contribution. See the instructions at [#31](../../issues/31).

## Contributing

LocalGen is currently split into three branches:

- **`release`**: The main branch, shown in the project homepage. Used for saving past ver. 1-4 releases and storing map/font data.
- **`v5-EGE`**: Main branch of version 5, under active development.
LocalGen versions 2 to 5 is built with [EGE Graphics](http://xege.org).
We are trying to build an object-oriented system based on EGE.
The releases published under this branch are **Windows only** for the limitations of EGE.
- **`v6`**: Main branch of version 6. **Starting from v6, we will migrate our UI to the Qt library.**
This version hopefully gives optimized performance and cross-platform support.

To contribute to our project, please create a pull request on the `v5-EGE` branch. Thanks.

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=SZXC-WG/LocalGen-new&type=Date)](https://star-history.com/#SZXC-WG/LocalGen-new&Date)

<!--
## Donate Please! (WeChat Pay and AliPay)
[![QIM4p.md.jpg](https://i.imgtg.com/2023/01/19/QIM4p.md.jpg)](https://imgtg.com/image/QIM4p)
[![Quwij.md.jpg](https://i.imgtg.com/2023/01/19/Quwij.md.jpg)](https://imgtg.com/image/Quwij)
-->

0 comments on commit 5f897f8

Please sign in to comment.