Skip to content

README Proposal Definitive Edition #4

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.

Sign up for GitHub

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

README Proposal Definitive Edition #4

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ac10b61
Update README.md
ArtistDev44 Aug 1, 2025
efce89a
Update README.md
ArtistDev44 Aug 4, 2025
b393e3e
Update README.md
ArtistDev44 Aug 4, 2025
501899c
Update README.md
ArtistDev44 Aug 4, 2025
92e2ea2
Update README.md
ArtistDev44 Aug 4, 2025
99073ad
Update README.md
ArtistDev44 Aug 4, 2025
fec6043
Merge branch 'main' into main
ArtistDev44 Aug 5, 2025
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
296 changes: 115 additions & 181 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,191 +1,50 @@
<a name="intro"></a>

<div align="center">
<img src="assets/logos/menu_game_logo.png">

# Resources for journalists.

🇵🇱 *Poland-based free & open-source multiplayer shooter* ***[whose code](https://github.com/TeamHypersomnia/Hypersomnia)*** *was used in* ***[Assassin's Creed and Skydio drones](https://github.com/TeamHypersomnia/rectpack2D#rectpack2d)***. *Written without a game engine, in C++, just 50 MB in size, 10 years in development, only one programmer and two designers. Featured in* ***[Linux Magazine](https://www.scribd.com/document/763273177/Linux-Magazine-October-2023-USA)*** (page 89), ***[Liam @ GamingOnLinux](https://mastodon.social/@gamingonlinux/112609228144158828)*** *and even on* ***[GitHub Blog](https://github.blog/open-source/gaming/game-bytes-january-2024/#hypersomnia-release-on-steam)***.

Played on [39th PolyLAN tournament in Switzerland](https://store.steampowered.com/news/app/2660970/view/4186736071064310840).
🇵🇱 *Poland-based free & open-source multiplayer shooter* :
- written without game engine, only in **C++**,
- which only size **50MB**,
- took **10 years** in development,
+ with only one developer and 2 designers
- [whose code](https://github.com/TeamHypersomnia/Hypersomnia) was used in **[Assassin's Creed and Skydio drones.](https://github.com/TeamHypersomnia/rectpack2D#rectpack2d)**

**[It also runs in the browser.](https://hypersomnia.io)**
Available on **[Windows, Linux & Mac](https://github.com/TeamHypersomnia/Hypersomnia?tab=readme-ov-file#downloads)** with **[Steam](https://store.steampowered.com/app/2660970/Hypersomnia)** and **[even in the browser!](https://hypersomnia.io)**

<a href="https://store.steampowered.com/app/2660970/Hypersomnia"> <img src="https://upload.wikimedia.org/wikipedia/commons/8/83/Steam_icon_logo.svg" height=70 hspace=1> </a>
> Played on the [39th PolyLAN tournament in Switzerland](https://store.steampowered.com/news/app/2660970/view/4186736071064310840).

[**Now on Steam.**](https://store.steampowered.com/app/2660970/Hypersomnia)
*Featured in [Linux Magazine](https://www.scribd.com/document/763273177/Linux-Magazine-October-2023-USA) page 89, [Liam @ GamingOnLinux](https://mastodon.social/@gamingonlinux/112609228144158828) and even on [GitHub Blog.](https://github.blog/open-source/gaming/game-bytes-january-2024/#hypersomnia-release-on-steam)*

**[Official YouTube Trailer.](https://www.youtube.com/watch?v=L4zSA34fD_E)**
**[Official YouTube Trailer](https://www.youtube.com/watch?v=L4zSA34fD_E)**

*Download all logos & screenshots* ***[as a ZIP file.](https://github.com/TeamHypersomnia/PressKit/archive/refs/heads/main.zip)***
*Download all logos & screenshots **[as a ZIP file.](https://github.com/TeamHypersomnia/PressKit/archive/refs/heads/main.zip)***

</div>
## Contents

- [Socials](#socials)
- [In Media](#in-media)
- [Videos](#videos)
- [Game Screenshots](#game-screenshots)
- [Logos](#logos)
- [YouTube miniatures](#youtube-miniatures)
- [Icons](#icons)
- [Factsheet](#factsheet)
- [Descriptions](#descriptions)
- [Short teaser v1](#short-teaser-v1)
- [Short teaser v2](#short-teaser-v2)
- [Long teaser v1](#long-teaser-v1)
- [Long teaser v2](#long-teaser-v2)
- [Lore teaser](#lore-teaser)
- [Links](#links)
- [In Media](#in-media)
- [Videos](#videos)
- [Game Screenshots](#game-screenshots)
- [Social media tags](#social-media-tags)
- [For gamers](#for-gamers)
- [For programmers](#for-programmers)
- [Author Bio](#author-bio)
- [Credits](https://github.com/TeamHypersomnia/PressKit/blob/main/CREDITS.md#intro)

# Socials

</div>

- **itch.io:** https://hyperdev.itch.io/hypersomnia
- **Browser version:** https://hypersomnia.io
- **Discord:** https://discord.com/invite/YC49E4G
- **Steam:** https://store.steampowered.com/app/2660970/Hypersomnia/
- **Telegram:** https://t.me/hypersomnia_io
- **Telegram (server monitor):** https://t.me/hypersomnia_monitor
- **Source code:** https://github.com/TeamHypersomnia/Hypersomnia
- **Homepage:** https://hypersomnia.xyz
- **Twitter:** https://twitter.com/teamhypersomnia
- **Twitch:** https://www.twitch.tv/directory/category/hypersomnia
- **YouTube:** https://www.youtube.com/@teamhypersomnia
- **Mastodon:** https://pol.social/@hypersomnia
- **Contact:** [email protected]

To reach me on Matrix, you can hop onto the [onFOSS chat](https://onfoss.org/) (I'm friends with them) and ping `@pythagoras`:
https://matrix.to/#/#irc_#onfoss:matrix.f-hub.org

***Note: Discord is the #1 social.*** *It is the home of our community where devs and players meet.*

# In Media

***(You could be here! Let me know about your publications at [email protected])***

<!--
<a href="https://pubhtml5.com/mxdt/dbwn/Linux_USA_10.2023_downmagaz.net/89"> <img src="https://upload.wikimedia.org/wikipedia/en/0/05/Linux_Magazine_international_logo.png" alt="Issue 275, page 89" width=200 hspace=1> </a>
<a href="https://news.ycombinator.com/item?id=36469297"> <img src="https://upload.wikimedia.org/wikipedia/en/b/bf/Hackernews_logo.png" width=200 hspace=1> </a>
-->

- **[Liam @ GamingOnLinux](https://mastodon.social/@gamingonlinux/112609228144158828)**: *Sounds like some impressive tech going on behind the scenes.*
- **[GitHub Blog](https://steamcommunity.com/linkfilter/?u=https%3A%2F%2Fgithub.blog%2F2024-01-18-game-bytes-january-2024%2F%23hypersomnia-release-on-steam)**: *Not just fun, it’s technically innovative.*
- **[Linux Magazine](https://pubhtml5.com/mxdt/dbwn/Linux_USA_10.2023_downmagaz.net/89)**: *The whole package is a zany quick blast of adrenaline.*
- **[HackerNews](https://news.ycombinator.com/item?id=36469297)**: *Show HN: Open-source shooter which made it to AC: Valhalla and Skydio drones.*
- **[lubiegrac.pl](https://lubiegrac.pl/news/hypersomnia-open-source-multiplayer-shooter-16-pssg)**: *Dziś w PSSG prezentujemy coś niezwykłego, tytuł który ma całkowicie inne podejście niż większość gier prezentowanych w PSSG.*
- **[pepper.pl](https://www.pepper.pl/promocje/sieciowa-strzelania-w-starym-dobrym-stylu-graj-w-przegladarce-i-na-steam-849432)** <sub>(461 votes)</sub>
- **[Open Source Friend](https://t.me/open_source_friend/2483)** <sub>(200 votes, 20k views)</sub>
- **[polskigamedev.pl](https://polskigamedev.pl/przeglad-tygodnia-4-10-grudnia/)**: *Twórcy marzy się, by Hypersomnia stała się profesjonalną grą eSportową.*
- **[zgrywuski.pl](https://zgrywuski.pl/hypersomnia-ma-wczesny-dostep-bez-wymagan-bez-silnika-bez-litosci/)**: *Bez wymagań, bez silnika, bez litości.*
- **[C++ Learning](https://t.me/Learning_pluses/1815)** <sub>(11k subscribers channel)</sub>
- [linuxgameconsortium.com](https://linuxgameconsortium.com/hypersomnia-a-tough-shooter-you-can-shape/): *Hypersomnia: a tough shooter you can shape.*
- [ifun.de](https://www.ifun.de/hypersomnia-freier-multiplayer-shooter-fuer-mac-win-und-linux-212657/): *Hypersomnia: Freier Multiplayer-Shooter für Mac, Win und Linux*.
- [GAMINGDEPUTY](https://www.gamingdeputy.com/hypersomnia-is-a-free-multiplayer-shooter-for-mac-win-and-linux/): *Hypersomnia is a free multiplayer shooter for Mac, Win and Linux*.

<div align="center">

# Videos

[![IMAGE ALT TEXT](https://img.youtube.com/vi/L4zSA34fD_E/0.jpg)](https://www.youtube.com/watch?v=L4zSA34fD_E "Video Title")

[![IMAGE ALT TEXT](https://img.youtube.com/vi/CHLPzZqANlM/0.jpg)](https://www.youtube.com/watch?v=CHLPzZqANlM "Video Title")

[![IMAGE ALT TEXT](https://img.youtube.com/vi/q1rfIy06_xo/0.jpg)](https://www.youtube.com/watch?v=q1rfIy06_xo "Video Title")

[![IMAGE ALT TEXT](https://img.youtube.com/vi/Nlh_dyd_V7w/0.jpg)](https://www.youtube.com/watch?v=Nlh_dyd_V7w "Video Title")

[![IMAGE ALT TEXT](https://img.youtube.com/vi/URWjNtUArDo/0.jpg)](https://www.youtube.com/watch?v=URWjNtUArDo "Video Title")

# Game Screenshots

<img src="assets/screenshots/screen_g0.png">
<img src="assets/screenshots/ss_cyberaqua.png">
<img src="assets/screenshots/screen_g6.png">
<img src="assets/screenshots/screen_g3.png">
<img src="assets/screenshots/screen_g5.png">

<!--
<img src="assets/screenshots/screen_g1.png">
-->

<img src="assets/screenshots/screen_2.png">

<img src="assets/screenshots/screen_3.png">

</div>

# Logos

## [menu_game_logo.png (585x104)](assets/logos/menu_game_logo.png?raw=1)

<img src="assets/logos/menu_game_logo.png">

<br>

## [discord_thread.gif (460x310)](assets/logos/discord_thread.gif?raw=1)
- Suitable as a miniature for Discord threads.

<img src="assets/logos/discord_thread.gif">

<br>
## Logos

## [steam_card.png (460x215)](assets/logos/steam_card.png?raw=1)
> The logos and others pictures of Hypersomnia can be seen [here, in github](https://github.com/TeamHypersomnia/PressKit/tree/main/assets/logos) or [downloaded in this zip file](https://github.com/TeamHypersomnia/PressKit/archive/refs/heads/main.zip).

<img src="assets/logos/steam_card.png">

<br>

## [github_card.png (920x460)](assets/logos/github_card.png?raw=1)

<img src="assets/logos/github_card.png">

<br>

## [twitch_capsule.png (600x800)](assets/logos/twitch_capsule.png?raw=1)

<img src="assets/logos/twitch_capsule.png">

<br>

## [twitch_capsule_nologo.png (600x800)](assets/logos/twitch_capsule_nologo.png?raw=1)

<img src="assets/logos/twitch_capsule_nologo.png">

<br>

## [steam_library_hero.png (3840x1240)](assets/logos/steam_library_hero.png?raw=1)

<img src="assets/logos/steam_library_hero.png">

# YouTube miniatures

## [yt_miniature_logo.png (1280x720)](assets/logos/yt_miniature_logo.png?raw=1)

<img src="assets/logos/yt_miniature_logo.png">

<br>

## [yt_miniature_nologo.png (1280x720)](assets/logos/yt_miniature_nologo.png?raw=1)

<img src="assets/logos/yt_miniature_nologo.png">

<br>

## [yt_miniature_nologo_alt.png (1280x720)](assets/logos/yt_miniature_nologo_alt.png?raw=1)

<img src="assets/logos/yt_miniature_nologo_alt.png">

# Icons

## [large_community_icon.png (224x224)](assets/logos/large_community_icon.png?raw=1)
<img src="assets/logos/large_community_icon.png">

# Factsheet
## Factsheet

- ***Hypersomnia*** is a free and open-source multiplayer top-down shooter for Windows, Linux and MacOS, **and the Web.**
- **[rectpack2D](https://github.com/TeamHypersomnia/rectpack2D)**, a part of the game code, was used in **[Assassin's Creed: Valhalla.](https://www.youtube.com/watch?v=2KnjDL4DnwM&t=2382s)**, **[Skydio drones](https://pages.skydio.com/rs/784-TUF-591/images/Open%20Source%20Software%20Notice%20v0.2.html)**, and [2 scientific papers.](https://scholar.google.com/scholar?hl=en&as_sdt=0%2C5&q=teamhypersomnia&btnG=)
Expand All @@ -200,40 +59,41 @@ https://matrix.to/#/#irc_#onfoss:matrix.f-hub.org
- Comes with an in-game WYSIWYG editor that lets you host a **work-in-progress map** to test with your friends in a single click. Quickly iterate your map unlike in any game engine.
- Licensed under **AGPL-3.0** - this means **everyone can modify Hypersomnia to their heart's content**, and even publish these altered versions under their name as long as they keep the complete source code public.

# Descriptions
## Descriptions

**Feel free to copy and reword these however you wish.**

Note these are taken directly from GitHub and Steam pages.
> [!Note]
> These are taken directly from GitHub and Steam pages.

## Short teaser v1
### Short teaser v1

*Challenge your friend to an intense duel, or gather two clans to fight a spectacular war. Reawaken your competitive spirit in this relentless top-down shooter. Comes with an in-game map Editor! Forever free and open-source.*

## Short teaser v2
### Short teaser v2

*Online shooter with relentless dynamics.*
*Challenge your friend to an intense duel, or gather two clans to fight a spectacular war.*

*Written in modern C++, without a game engine*
*Forever free and open-source :heart:*

## Long teaser v1
### Long teaser v1

*Hypersomnia* is a free and open-source competitive shooter.

The game has been online and playable since 2017. It brings together:

- the tactics of *Counter-Strike*,
- the tactics of *Counter-Strike*,
- the dynamics of *Hotline Miami*,
- the pixel art nostalgia of oldschool RPGs..
- ..and the potential for endless creativity thanks to an in-game map editor!
- the pixel art nostalgia of oldschool RPGs
- and the potential for endless creativity thanks to an in-game map editor!

*Hypersomnia* aims to be **the ultimate open-source 2D shooter** - a grand community project extensible without limit.

## Long teaser v2
### Long teaser v2

*Hypersomnia* is a hardcore shooter mixing eSports with pixely nostalgia.
*Hypersomnia* is a hardcore shooter mixing eSports with pixel nostalgia.
Every match will be unforgiving - every duel a psychological battle.

More of a peaceful soul?
Expand All @@ -250,29 +110,102 @@ Features:
- 2 game modes: Bomb defusal (team-based) and Gun game (free-for all).
- An in-game map editor that lets you host a work-in-progress map to test with your friends in a single click. Quickly iterate your map unlike in any game engine.

## Lore teaser
</div>

## Links

### Community

- **Discord:** https://discord.com/invite/YC49E4G
- **Mastodon:** https://pol.social/@hypersomnia
- **Contact:** <a href="mailto:[email protected]"> [email protected] </a>

### Medias

*Declare allegiance to one of the three factions whose apple of discord is a disparity between prevailing notions of moral excellence:*
- **Twitter:** https://twitter.com/teamhypersomnia
- **Twitch:** https://www.twitch.tv/directory/category/hypersomnia
- **YouTube:** https://www.youtube.com/@teamhypersomnia
- **Telegram:** https://t.me/hypersomnia_io

### Project

- **Homepage:** https://hypersomnia.xyz
- **Source code:** https://github.com/TeamHypersomnia/Hypersomnia

***Metropolis. Atlantis. Resistance.***
### Game

- **itch.io:** https://hyperdev.itch.io/hypersomnia
- **Browser version:** https://hypersomnia.io
- **Steam:** https://store.steampowered.com/app/2660970/Hypersomnia/
- **Telegram (server monitor):** https://t.me/hypersomnia_monitor

To reach me on Matrix, you can hop onto the [onFOSS chat](https://onfoss.org/) (I'm friends with them) and ping `@pythagoras`:
https://matrix.to/#/#irc_#onfoss:matrix.f-hub.org

*Will you take revenge for the unethical simulation of an inferior universe? Will you support the cruel experiments to win total control over metempsychosis? Or will you join the underground civilization that awaits the end of war in this dangerous afterlife reality?*
> [!Note]
> **Note: Discord is the #1 social.** It is the home of our community where devs and players meet.

## In Media

***(You could be here! Let me know about your publications at [email protected])***

<!--
<a href="https://pubhtml5.com/mxdt/dbwn/Linux_USA_10.2023_downmagaz.net/89"> <img src="https://upload.wikimedia.org/wikipedia/en/0/05/Linux_Magazine_international_logo.png" alt="Issue 275, page 89" width=200 hspace=1> </a>
<a href="https://news.ycombinator.com/item?id=36469297"> <img src="https://upload.wikimedia.org/wikipedia/en/b/bf/Hackernews_logo.png" width=200 hspace=1> </a>
-->

- [**Liam @ GamingOnLinux**](https://mastodon.social/@gamingonlinux/112609228144158828): Sounds like some impressive tech going on behind the scenes.
- [**GitHub Blog**](https://steamcommunity.com/linkfilter/?u=https%3A%2F%2Fgithub.blog%2F2024-01-18-game-bytes-january-2024%2F%23hypersomnia-release-on-steam): Not just fun, it’s technically innovative.
- [**Linux Magazine**](https://fr.scribd.com/document/763273177/Linux-Magazine-October-2023-USA#page=89): The whole package is a zany quick blast of adrenaline.
- [**HackerNews**](https://news.ycombinator.com/item?id=36469297): Show HN: Open-source shooter which made it to AC: Valhalla and Skydio drones.
- [**Open Source Friend**](https://t.me/open_source_friend/2483) Hypersomnia - это онлайн-шутер, написанный на современном C++.
- [**zgrywuski.pl**](https://zgrywuski.pl/hypersomnia-ma-wczesny-dostep-bez-wymagan-bez-silnika-bez-litosci/): Bez wymagań, bez silnika, bez litości.
- [**linuxgameconsortium.com**](https://linuxgameconsortium.com/hypersomnia-a-tough-shooter-you-can-shape/): Hypersomnia: a tough shooter you can shape.
- [**ifun.de**](https://www.ifun.de/hypersomnia-freier-multiplayer-shooter-fuer-mac-win-und-linux-212657/): Hypersomnia: Freier Multiplayer-Shooter für Mac, Win und Linux.
- [**gamingdeputy.com**](https://www.gamingdeputy.com/hypersomnia-is-a-free-multiplayer-shooter-for-mac-win-and-linux/): Hypersomnia is a free multiplayer shooter for Mac, Win and Linux.

<div align="center">

### Videos

|Trailer|Gameplay|Tutorial|Dev_Journal
|---|---|---|---|
[![IMAGE ALT TEXT](https://img.youtube.com/vi/L4zSA34fD_E/0.jpg)](https://www.youtube.com/watch?v=L4zSA34fD_E "Trailer")|[![IMAGE ALT TEXT](https://img.youtube.com/vi/CHLPzZqANlM/0.jpg)](https://www.youtube.com/watch?v=CHLPzZqANlM "Gameplay")|[![IMAGE ALT TEXT](https://img.youtube.com/vi/q1rfIy06_xo/0.jpg)](https://www.youtube.com/watch?v=q1rfIy06_xo "Tutorial")|[![IMAGE ALT TEXT](https://img.youtube.com/vi/URWjNtUArDo/0.jpg)](https://www.youtube.com/watch?v=URWjNtUArDo "Dev_Journal")

</div>

# Social media tags
## Social media tags

## For gamers
### For gamers

*(comma-separated)*

``hypersomnia, hypersomnia shooter, teamhypersomnia, open source shooter, free shooter, free 2d shooter, 2d topdown, 2d topdown shooter, topdown shooter, top-down shooter, pixelart, pixel art, pixel-art shooter, indie shooter, 2d shooter, online shooter, competitive shooter, competitive 2d``

## For programmers
### For programmers

*(space-separated)*

``game cpp c-plus-plus gamedev multiplayer pixel-art game-development free-software shooter multiplayer-game 2d-game shooter-game pixelart top-down-shooter 2d-shooter pixelart-game top-down-game indie-game top-down-shooter-game topdown-shooter``

# Author Bio
## Game Screenshots

<table>
<tr>
<th><img src="assets/screenshots/screen_g0.png" width="100%"></th>
<th><img src="assets/screenshots/ss_cyberaqua.png" width="100%"></th>
</tr>
<tr>
<td><img src="assets/screenshots/screen_g6.png"</td>
<td><img src="assets/screenshots/screen_g3.png"</td>
</tr>
<tr>
<td><img src="assets/screenshots/screen_g5.png"</td>
<td><img src="assets/screenshots/screen_2.png"</td>
</tr>
</table>

## Author Bio

- **When I was 13**, my only wish was to have my own MMORPG.
- This is when I picked up my first programming book, [Symfonia C++](https://www.ifj.edu.pl/private/grebosz/symfonia_c++_std_p.html) by Jerzy Grębosz.
Expand All @@ -282,8 +215,9 @@ Features:
- I later went on multiple year-long breaks from work to focus on writing *Hypersomnia*, whilst living from my savings.
- Since 2020, I have become passionate about investing, thanks to which my savings lasted way longer than they'd otherwise.
- My financial decisions now let me focus 100% on *Hypersomnia*.
- I use Arch Linux, and I wrote *Hypersomnia* in NeoVim, *without* autocomplete (but with 21 other plugins - [vim-easymotion](https://github.com/easymotion/vim-easymotion) being my favourite).
- I use Arch Linux (btw), and I wrote *Hypersomnia* in NeoVim
- *without* autocomplete (but with 21 other plugins - [vim-easymotion](https://github.com/easymotion/vim-easymotion) being my favorite).

# Credits
## Credits

[See here.](https://github.com/TeamHypersomnia/PressKit/blob/main/CREDITS.md#intro)
[**See here**](https://github.com/TeamHypersomnia/PressKit/blob/main/CREDITS.md#intro)