Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #204

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 95 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,72 @@
Pingus
======
Guide your penguins to safety!

Introduction
------------

Pingus is a free Lemmings™ clone for GNU/Linux, Win32 and other
operating systems supported by SDL2. It is licensed under the GPLv3+.
Pingus is a free, open-source puzzle game inspired by the classic Lemmings™ clone. It is available for GNU/Linux, Win32 and other
operating systems supported by SDL2. Pingus Challenges you to guide a group of penguins through various obstacles to reach the exit safely. The game features engaging graphics, a variety of levels, and a built in level editor for endless possibilities and fun. It is licensed under the GPLv3+.

Information about the game, new versions and additional documentation
can be found at the Pingus webpage:

* https://pingus.github.io/

Table of Contents
-------------

Features
Installation
Linux
Windows
macOS
Building
Launching the Game
Game Controls
Community
Mailing Lists
Chat
Bug Reports
Contributing
License

Features
--------

* Over 100 Challenging Levels: Navigate through a variety of levels with increasing difficulty.
* Level Editor: Create your own levels and share them with the community.
* Engaging Graphics: Enjoy cute and colorful graphics that bring the game to life.
* Sound Effects and Music: Immerse yourself in the game with delightful audio.
* Multilingual Support: Available in multiple languages.
* Cross-Platform: Play on Linux, Windows, and other systems supported by SDL2.

Installation
--------
Linux)
Pingus can be installed on Linux using the Nix package manager:
nix run github:pingus/pingus

Alternatively, Pingus may be available in your distribution's repositories:

Ubuntu/Debian:
sudo apt-get install pingus

Fedora:
sudo dnf install pingus

Arch Linux:
sudo pacman -S pingus

Windows)

Download the latest Windows installer from the Pingus Releases page or compile it on Linux using:
nix build github:pingus/pingus#packages.i686-windows.pingus-win32

macOS)

Currently, Pingus does not have an official macOS installer. You can compile it from source using the instructions below.


Building
--------
Expand All @@ -26,6 +81,35 @@ The Windows version can be compiled in Linux with:
nix build github:pingus/pingus#packages.i686-windows.pingus-win32


Launching the Game
-----------
After installation or building from source, you can launch Pingus from your application menu or by running the following command in the terminal:
pingus

If you used Nix to run the game:
nix run github:pingus/pingus

Game Controls
----------
Action Key
Move cursor Mouse
Select/Deselect Left Mouse Button
Assign Action Left Mouse Button on penguin
Pause/Unpause Game P
Speed Up Game + (Plus key)
Slow Down Game - (Minus key)
Open In-Game Menu Esc
Move Map Move mouse to screen edge or use Arrow Keys
Zoom In Page Up
Zoom Out Page Down
Toggle Fullscreen F
Restart Level R
Exit Level E
Display Help H
Quit Game Ctrl + Q

Can Change game controls in the settings menu.

Mailing Lists
-------------

Expand All @@ -51,3 +135,12 @@ issue tracker at:

* https://github.com/pingus/pingus/issues


Contributing
--------

Contributions are welcome! Whether it's reporting bugs, creating levels, improving documentation, or contributing code, your help is appreciated.

* Code Contributions: Fork the repository, make your changes, and submit a pull request.
* Level Creation: Use the built-in level editor and share your levels with the community.
* Translations: Help translate Pingus into other languages.