{"size": 1980, "ext": "scrbl", "max_stars_repo_path": "scribblings/codespells-live.scrbl", "max_stars_repo_name": "ldhandley/codespells-live", "max_stars_repo_stars_event_min_datetime": null, "max_stars_repo_stars_event_max_datetime": null, "max_issues_repo_path": "scribblings/codespells-live.scrbl", "max_issues_repo_name": "ldhandley/codespells-live", "max_issues_repo_issues_event_min_datetime": "2021-04-08T22:32:44.000Z", "max_issues_repo_issues_event_max_datetime": "2021-05-19T21:28:23.000Z", "max_forks_repo_path": "scribblings/codespells-live.scrbl", "max_forks_repo_name": "ldhandley/codespells-live", "max_forks_repo_forks_event_min_datetime": null, "max_forks_repo_forks_event_max_datetime": null}
{"max_stars_count": null, "max_issues_count": 35, "max_forks_count": null, "avg_line_length": 25.7142857143, "max_line_length": 94, "alphanum_fraction": 0.6727272727}
#lang scribble/manual
@require[@for-label[codespells-live
                    racket/base]]

@title{codespells-live}
@author{ThoughtSTEM}

@section{Language for the Twitch Chat}
@defmodule[codespells-live/chat]

@(tt "codespells-live/chat") is the language for interacting
with our Twitch stream
@(link "https://www.twitch.tv/codespells" "here"). Any of
commands below can be run inside the Twitch chat preceded by a
@tt{!!} and minus the outer set of parentheses. (E.g. @tt{!!mini})

@defproc[(mini)
         void?]{
  Spawns a mini of the viewer in the virtual world.
}

@defproc[(color [c color?])
         void?]{
  Changes the color of the Transcendent Being. 
}

@defproc[(say [str string?])
         void?]{
  Changes the text on any sign that the Transcendent Being
 is holding.
}

@defproc[(cheer)
         void?]{
  Creates an explosion particle effect at the location
 of the viewer's mini. Nothing happens if the viewer does
 not have a mini yet.
}

@defproc[(face [f face?])
         void?]{
  Changes the face of the Transcendent Being. 
}

@defproc[(run [id integer?])
         void?]{
  Runs a spell from the spell-sharing server with given id.
}

@section{Language for the Spell Sharing Server}
@defmodule[codespells-live/spell-lang]

@tt{codespells-live/spell-lang} is the extended language that can be used on the Spell Sharing
Server @(link "https://spell-client.vercel.app/" "here").

@defproc[(sleep [s integer?])
         void?]{
  Pauses for a given number of seconds. 
}

@section{Util}
@defmodule[codespells-live/util]

@defproc[(color? [x any/c?])
         boolean?]{
  Returns true if x is in the allowed color list:
  @tt{red}, @tt{orange}, @tt{green}, @tt{blue}.
}

@defproc[(face? [x any/c?])
         boolean?]{
  Returns true if x is in the allowed face list:
  @tt{bernie-sanders}, @tt{doge}, @tt{grumpy-cat},
 @tt{polite-cat}, @tt{sad-pepe}, @tt{shocked-cat},
 @tt{surprised-cat}, @tt{surprised-pikachu}, @tt{troll-face},
 @tt{you-kidding-me}.
}