Skip to content

Commit

Permalink
Expand landing page and add a FAQ
Browse files Browse the repository at this point in the history
  • Loading branch information
Rosuav committed Jun 14, 2024
1 parent 30ffa75 commit 5a9a431
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 10 deletions.
7 changes: 7 additions & 0 deletions modules/http/index.pike
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,19 @@ mapping(string:mixed)|Concurrent.Future http_request(Protocols.HTTP.Server.Reque
{
loglink = "[Log out](:.twitchlogout)";
yourname = "You are currently logged in as " + yourname + ".";
int id = (int)req->misc->session->user->id;
if (id && G->G->irc->id[id]) yourname += " [Manage your channel](/c/)";
}
return render_template("index.md", ([
"botname": G->G->dbsettings->credentials->username,
"yourname": yourname, "loglink": loglink,
]));
}

mapping(string:mixed)|Concurrent.Future faq(Protocols.HTTP.Server.Request req) {
return render_template("faq.md", ([]));
}

//Timing tests. Each performs exactly one database query; "ro" should be able to be resolved
//from the fast local database, but "rw" will always go to the active (non-read-only) DB.
__async__ string pingro(Protocols.HTTP.Server.Request req) {
Expand All @@ -29,6 +35,7 @@ protected void create(string name)
{
::create(name);
G->G->http_endpoints[""] = http_request;
G->G->http_endpoints["faq"] = faq;
G->G->http_endpoints["pingro"] = pingro;
G->G->http_endpoints["pingrw"] = pingrw;
}
36 changes: 36 additions & 0 deletions templates/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Frequently Asked Questions

<!-- Banner here again? -->

## So what's with the name?

It's an Alice in Wonderland reference. When Alice and the Duchess were discussing
all manner of things and their morals, they determined that mustard was a mineral -
and one that was mined. And the moral of that became the motto of this bot: "The
more [work] there is of mine, the less there is of yours".

Other names you'll see associated with this bot include StilleBot (the name of the
bot's software), Rosuav (the name of the bot's author), Pike (the programming
language the bot uses), and Chocolate Factory (the front end UI library used).

## Is it really free?

Yep. At the moment, I have no monetization plans; if you want to donate, you're
welcome to, but all features are available to everyone. In the future, I may offer
some sort of paid cosmetic enhancements, but all core features should always remain
free to use.

## Your bot is speaking in my channel and I don't like it.

Sorry about that! You can remove the bot from your channel by going to your [Master
Control Panel](/c/mastercontrol); only the broadcaster can do this, and it requires
confirmation.

## Who makes this bot?

The bot is the creation of Rosuav, found under that name on Twitch, Discord, GitHub,
and pretty much everywhere. Contact him with further questions.

[The bot's source code](https://github.com/rosuav/stillebot) is available to anyone
who wishes to use it, learn from it, or borrow code from it.

32 changes: 22 additions & 10 deletions templates/index.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,32 @@
# Mustard Mine

Mustard Mine is a Twitch channel bot. This one operates under the name "$$botname$$",
but [the source code](https://github.com/rosuav/stillebot) is available to anyone
who wishes to use it, learn from it, or borrow code from it.
<!-- Banner goes here -->

Information about each channel that this bot serves is available.
<form method=get action="/channels/">Select a Twitch channel: <input name=chan size=20><input type=submit value="Show"></form>
Mustard Mine is a Twitch channel bot. It offers a wide variety of tools to streamers
and viewers, including:

* Simple commands to give information
* Responses to stream support such as subscriptions and cheers
* Integrations with online shops (Ko-fi, Fourth Wall)
* Goal bars, including multi-leveled goal bars
* Hype Train tracking and reporting
* Management of channel point rewards
* Stream preparation eg setting title, category, tags
* On-screen alerts
* Raid target searching in various forms
* And, as they say, much much more!

Unsure if you want to use this bot? Nearly all the features can be explored in [demo mode]
(/channels/demo) where you have the power of a moderator in a mythical channel!

Interested? [Activate the bot here!](/activate)

Want to learn more? Check out [our FAQ](/faq) or contact Rosuav on Twitch or Discord.

$$yourname$$ $$loglink$$

Additional features and toys available here:
Quick links:
* [See who has which bit badges in your channel](/bitsbadges) (needs login)
* [Emote checklist](/checklist)
* [An alternate view to your follow list, good for picking raid targets](/raidfinder)
* <form method=get action="/hypetrain">Hype train status for a Twitch channel: <input name=for size=20><input type=submit value="Show"></form>
* <form method=get action="/emotes">Emote showcase for any channel: <input name=broadcaster size=20><input type=submit value="Show"></form>
* [Path to Affiliate streamer tracking](/affiliate). If you're helping to guide streamers to this milestone, this page can help with tracking and recommendations.
* [OAuth scope trimmer to help you tame the wild mess of permissions that sites ask for](/scopetrim)
* [Curious what the bot can do for you? Try the demo!](https://mustardmine.com/channels/demo/)

0 comments on commit 5a9a431

Please sign in to comment.