sparky

A 5v5, blazingly fast, character-based libre tactical shooter written in pure C. 🎲

https://github.com/sparky-game/sparky

Keywords

Repository

A 5v5, blazingly fast, character-based libre tactical shooter written in pure C. 🎲

README.org

# 
# GNU Sparky --- A 5v5 character-based libre tactical shooter
# Copyright (C) 2024 Wasym A. Alonso
# 
# This file is part of Sparky.
# 
# Sparky is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# 
# Sparky is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
# 
# You should have received a copy of the GNU General Public License
# along with Sparky.  If not, see .
# 


#+AUTHOR: Wasym A. Alonso

# Logo & Title
#+begin_html




Sparky

#+end_html

# Subtitle
#+begin_html

A 5v5 character-based libre tactical shooter

#+end_html

# Repository marketing badges
#+begin_html










#+end_html

# Repository info badges
#+begin_html







#+end_html

# Repository CI badges
#+begin_html











#+end_html

# Dedication
#+begin_quote
 This project is created and maintained in loving memory of *Sparky*, aka *Chispitas*, aka *Chispis*, in the hope he will become immortal and, eventually, one with the Force.  @@html:
@@
/To the moon and back, forever /
#+end_quote

*Defy the limits:* Blend your style and experience on a global, competitive stage. You have 13 rounds to attack and defend your side using sharp gunplay and tactical abilities. And, with one life per-round, you'll need to think faster than your opponent if you want to survive.

*Creativity is your greatest weapon:* More than guns and bullets, youll choose a character armed with adaptive, swift, and lethal abilities that create opportunities to let your gunplay shine. No two characters play alike, just as no two highlight reels will look the same.

*Fight around the world:* Each map is a playground to showcase your creative thinking. Purpose-built for team strategies, spectacular plays, and clutch moments. Make the play others will imitate for years to come.

# GNU GPLv3+ License notice
#+begin_quote
Sparky is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. @@html:
@@
Sparky is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. @@html:
@@
You should have received a copy of the GNU General Public License along with Sparky. If not, see .
#+end_quote

# Graphic's style (Low Poly)
#+begin_html



#+end_html

* Table of Contents :toc:
- [[#projects-roadmap][Project's roadmap]]
- [[#documentation][Documentation]]
- [[#usage][Usage]]
- [[#binary-distributions][Binary distributions]]
- [[#build-from-source][Build from source]]
  - [[#get-the-code][Get the code]]
  - [[#dependencies][Dependencies]]
    - [[#debianubuntu][Debian/Ubuntu]]
    - [[#fedora][Fedora]]
    - [[#arch][Arch]]
    - [[#gentoo][Gentoo]]
    - [[#freebsd][FreeBSD]]
    - [[#openbsd][OpenBSD]]
    - [[#macos][macOS]]
  - [[#compilation--linkage][Compilation & Linkage]]

* Project's roadmap

For information about the detailed project's roadmap, including delivered milestones, see [[https://github.com/orgs/sparky-game/projects/1][the Sparky's Roadmap on GitHub]].

* Documentation

The documentation of /Sparky/ includes:

- Main documentation /(Coming soon!)/
- Reference manual /(Coming soon!)/
- GDD (Game Design Document) /(Coming soon!)/
- API documentation /(Coming soon!)/

* Usage

#+begin_example
$ ./sparky -h
Usage: ./sparky [OPTION]
GNU Sparky --- A 5v5 character-based libre tactical shooter

If no option is provided, the client will start in offline mode.

Options:
  -g, --gui 		start the graphical launcher
  -i, --ip  	start the client and connect to the server at 
  -s, --server 		start the server
  -h, --help 		display this help and exit
  -v, --version 	output version information and exit

Report bugs to: 
GNU Sparky home page: 
General help using GNU software: 
#+end_example

* Binary distributions

(...)

* Build from source

In order to build /Sparky/ from source, preparation is needed so as to the environment is properly setup and ready.

** Get the code

First, download the codebase of the project. It's important to do so via the *OFFICIAL* Git repository hosted on [[https://github.com/sparky-game/sparky][GitHub]], and not through any tarball or compressed archive to ensure no tampering is done with the code. Appart from that, any ref can be checked out, being ~master~ (the trunk of all dev progress), a tagged commit (e.g. ~v1.0~), an actively maintained version branch (e.g. ~v1.0.y/stable~) or a LTS version branch (e.g. ~v1.0.y/lts~) the preferred ones.

To clone the official repo as well as all its submodules, issue the following command:

#+begin_src sh
git clone --recurse-submodules https://github.com/sparky-game/sparky
#+end_src

** Dependencies

These are the packages needed to be able to build /Sparky/ from source, they are divided by distribution/package manager. Also, a command for each one is added to make the installation of these development dependencies as easy and straightforward as possible.

- ~make~
- ~gcc~ / ~clang~
- ~rustc~ + ~cargo~
- ~jq~
- ~libX11~
- ~libXcursor~
- ~libXrandr~
- ~libXinerama~
- ~libXi~

*** Debian/Ubuntu

#+begin_src sh
xargs sudo apt install -y < Aptfile
#+end_src

*** Fedora

#+begin_src sh
sudo dnf install -y make gcc cargo jq libX11-devel libXcursor-devel libXrandr-devel libXinerama-devel libXi-devel
#+end_src

*** Arch

#+begin_src sh
sudo pacman -S make gcc rust jq libx11 libxcursor libxrandr libxinerama libxi
#+end_src

*** Gentoo

#+begin_src sh
sudo emerge -va make gcc rust-bin jq libX11 libXcursor libXrandr libXinerama libXi
#+end_src

*** FreeBSD

#+begin_src sh
sudo pkg install gmake rust jq libX11 libXcursor libXrandr libXinerama libXi
#+end_src

*** OpenBSD

#+begin_src sh
sudo pkg_add gmake rust jq
#+end_src

*** macOS

#+begin_src sh
brew bundle install --file=Brewfile
#+end_src

** Compilation & Linkage

#+begin_example
$ make help
Targets
=======
  all        :: Build all targets marked with [*]
,* checkdeps  :: Check dependencies for build process
  menuconfig :: Edit build options with ncurses menu
,* game       :: Build the bare game
  check      :: Build and run the test engine
  editor     :: Build the editor
  clean      :: Remove the 'build' directory
  mrproper   :: Remove and cleans everything
  version    :: Show the current version string
  help       :: Show this help and usage panel

Execute 'make' or 'make all' to build all targets marked with [*]
For further info see the ./README.org file
#+end_example

First, ensure the source tree is absolutely clean. From /Sparky/ we recommend this command to be issued prior to each compilation; do not rely on the source tree being clean after cloning the repository or after un-tarring:

#+begin_src sh
make mrproper
#+end_src

There are several ways to configure the build process for it to suit your needs. The most user-friendly way to do so is through a menu-driven interface:

#+begin_src sh
make menuconfig
#+end_src

To build the game, issue the following command:

#+begin_src sh
make
#+end_src

Next, run the test suite:

#+begin_src sh
make check
#+end_src

Owner

GitHub Events

Issues and Pull Requests

Last synced: almost 2 years ago