Skip to content

Commit

Permalink
ADD support for Gitlab's pages
Browse files Browse the repository at this point in the history
Add instructions to build Gitlab pages and mention it in the readme.
  • Loading branch information
oelmekki committed Jul 4, 2023
1 parent 0a455db commit 792c804
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 14 deletions.
13 changes: 13 additions & 0 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# The Docker image that will be used to build your app
image: ruby:2.7
pages:
script:
- cp -r index.html css js img public/
artifacts:
paths:
# The folder that contains the files to be exposed at the Page URL
- public
rules:
# This ensures that only pushes to the default branch will trigger
# a pages deploy
- if: $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH
34 changes: 21 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# Shadowrun Anarchy Mission Generator

> [Shadowrun](https://www.shadowrunsixthworld.com/) is a tabletop RPG owned
> by Catalyst Game Labs. [Shadowrun Anarchy](https://store.catalystgamelabs.com/products/shadowrun-anarchy-pdf) is
> an edition of Shadowrun with simplified rules, meant for storytelling,
> by Topps and published by Catalyst Game Labs. [Shadowrun
> Anarchy](https://store.catalystgamelabs.com/products/shadowrun-anarchy-pdf)
> is an edition of Shadowrun with simplified rules, meant for storytelling,
> based on the Cue System, previously used in other titles from Catalyst
> Game Labs.
>
> [Controlled Anarchy](https://www.surprisethreat.com/single-post/controlled-anarchy) is a fanmade
> supplement of rules to play with a rotating game master, like the Cue
> System used to allow in previous titles.
> [Controlled
> Anarchy](https://www.surprisethreat.com/single-post/controlled-anarchy)
> is a fanmade supplement of rules to play with a rotating game master,
> like the Cue System used to allow in previous titles.
Shadowrun Anarchy Generator allows to automatize generating contract briefs
for use in Shadowrun Anarchy, through Controlled Anarchy.
Expand All @@ -20,7 +22,8 @@ If you don't know Controlled Anarchy, [go give it a read](https://www.surpriseth
is about generating a vague mission brief that players playing without a
dedicated game master can get inspired by to develop their shared narration
while playing. It does not generate detailed mission, just enough to
trigger imagination.
trigger imagination (a concept those of you who use oracles for their
roleplaying know well).

This webapp allows to automatize the part of Controlled Anarchy which is
about generating a mission brief and the part about generating NPCs, so
Expand All @@ -31,9 +34,11 @@ computation.

## Where

The app can be run through [github pages here](https://oelmekki.github.io/sra-mission/).
The app can be run through [Gitlab pages here](https://oelmekki.gitlab.io/sra-mission/).

Or the french version : [github pages here](https://oelmekki.github.io/sra-mission/?lang=fr).
Or the French version : [Gitlab pages here](https://oelmekki.gitlab.io/sra-mission/?lang=fr).

Alternatively, on Github: [English](https://oelmekki.github.io/sra-mission/) and [French](https://oelmekki.github.io/sra-mission/?lang=fr)


## A word about maintenance
Expand All @@ -53,15 +58,18 @@ as changing something to make it more useful to you. You could even use
this app as a basis to make your own scene generator for a completely
different TTRPG.

Sra-mission is currently hosted on Github pages. That means it will be
publicly available until… Github decides to shut down the service or change
Sra-mission is currently hosted on Gitlab and Github pages. That means it will be
publicly available until… Gitlab and Github decide to shut down the service or change
it in a way that breaks the app. May be tomorrow, may be never. Until then,
if you want to change something in sra-mission and make it available, it's
as simple (if you're used to Github) as forking this repository, making
your change and activating Github pages in your new repository's settings.
The standalone files are not used by Github pages, edit the other files if
as simple (if you're used to Gitlab/Github) as forking this repository, making
your change and activating Gitlab/Github pages in your new repository's settings.
The standalone files are not used by Gitlab/Github pages, edit the other files if
you want to change something (all wording is in `js/translations/`).

If you want to send a pull request / merge request, please do it [on
Gitlab](https://gitlab.com/oelmekki/sra-mission).


## Credits

Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<div id="root">
<div id="app" class="page">
<nav id="langs">
<a href="https://github.com/oelmekki/sra-mission">source code</a>
<a href="https://gitlab.com/oelmekki/sra-mission">source code</a>
<a href="?lang=en">English</a>
<a href="?lang=fr">Français</a>
</nav>
Expand Down
Empty file added public/.gitkeep
Empty file.

0 comments on commit 792c804

Please sign in to comment.