Skip to content

Commit

Permalink
polished readme
Browse files Browse the repository at this point in the history
  • Loading branch information
a456pur committed Jul 29, 2024
1 parent c9dcefd commit d739516
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 14 deletions.
38 changes: 24 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<img src="images/seraphbanner.png">
<img src="images/seraphbanner.jpg">
<p align="center">
seraph; an open source game website that hosts 350+ games with cloaking tab functionality, multiple themes, full rehosting support and content updates frequently
seraph; an open source game website that hosts 350+ games with customisable settings, full rehosting support and a beautiful design
<br/>
<a href="https://seraph.reveriestudios.online/">go to seraph</a>
<a href="https://seraph.reveriestudios.online/">view demo</a>
·
<a href="https://github.com/a456pur/seraph/issues/new/choose">report issue / request feature</a>
<a href="https://github.com/a456pur/seraph/issues/new/choose">report issues / request feature</a>
·
<a href="https://discord.gg/ZyZDmx3zuQ">discord server</a>
<a href="https://discord.gg/ZyZDmx3zuQ">discord</a>
<br>
<br>
<img src="https://img.shields.io/github/repo-size/a456pur/seraph?style=for-the-badge&labelColor=%23000000&color=%231c1c1c">
Expand All @@ -15,26 +15,27 @@
</p>

## features
- 350+ games! no embedding from other sites, no hacky workarounds needed to get in, all locally hosted on the website!
- an apps catalogue hosting useful tools and utilities, as well as fun little showcases
- cloaking tab functionality allowing you to disguise your tab in plain sight, syncing with all pages on the site
- multiple themes changing the colour and overall appearance of the site to make it yours
- a hosting page with instructions on how to rehost seraph for free
- a full update log page detailing every change made to the website
- frequent content updates with new games and website enhancements
- **350+ games:** no embedding, no workarounds - games ranging from unity to flash to emulators and more!
- **10+ apps:** a dedicated area hosting apps, ranging from useful utilities to fun web engine showcases
- **offline mode:** download over 110+ games from the games page and run the site in a minimised state; all without an internet connection
- **personalisation:** nine custom curated themes with unique backgrounds and colour schemes + a highly expansive custom theme editor complete with importing/exporting of themes
- **settings:** cloaking tab, panic key customisations, import/export data, clear site data & open games in new tabs
- **mobile:** an exclusive page dedicated to mobile users, featuring mobile games and the same functional experience as normal seraph
- **and more!** a hosting page with details on how to clone seraph, a full update log, open blank + more

## credits
**resources used**
- ruffle: allows flash games to be run on the website without any prior installation necessary
- emulatorjs: enables our collection of game boy color, game boy advance, nintendo ds, snes, nes and sega mega drive to run on the website

**credits**
- lifesaskit: background assistance for multiple themes
- lifesaskit: background contributions (azure, cosmic, ethereal, ghostly, metro, retro)
- skysthelimit: additional assistance

**game assets**
- 3kh0: [game asset repository](https://github.com/3kh0/3kh0-Assets)
- nate-games: [nate-games repository](https://github.com/nate-games/nate-games.xyz)
- selenite: [selenite repository](https://github.com/selenite-cc/selenite)
- nate-games: [nate-games repository](https://github.com/nate-games/nate-games.xyz)

**contributions**
- heheheha12345678: game suggestions, bug reporting, website suggestions
Expand All @@ -45,6 +46,15 @@
- ninjanick56: game suggestions
- geotobogaming: general support

## repurposing
seraph is completely open source which allows you to inspect any element of the site on github, as well as being able to download assets for yourself.

*you are 100% allowed to extract games and apps from the site without any credit necessary.* (although it'd still be appreciated!). you can also change around the homepage and any other pages on the site to add or modify content and there will be no fuss from any of us.

although i dont mind not being credited, please don't just do something as simple as changing the name of the site then replacing any mentions of my name. it's an extremely scummy thing to do, especially if you claim the site as your own creation when there's a lot of effort put in behind the scenes!!

tldr; take anything game/app you want without credit!! add/modify seraph if you want, however don't replace my credit on the actual site if you can

## contributing
you can contribute to seraph in multiple ways by [raising issues on the github](https://github.com/a456pur/seraph/issues/new/choose), which can include:
- **game suggestions:** suggest games to be added to seraph! provide a link if possible to the game to make it easier to add
Expand Down
Binary file added images/seraphbanner.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d739516

Please sign in to comment.