Maiden-Crimes

Package Index

MAIDEN-CRIMES (ORG.SHIRAKUMO.MAIDEN.AGENTS.CRIMES)

special

`CARDCAST/DECK`

Address to retrieve information about a cardcast deck from.

special

`CARDCAST/DECK/CARDS`

Address to retrieve a list of cards for a cardcast deck from.

special

`CARDCAST/DECKS`

Address to retrieve a list of cardcast decks from.

special

`DECKS`

A hash-table of deck names to deck instances.

See DECK
See REMOVE-DECK

class
ADD-CALL
```
 
```
class
ADD-DECK
```
 
```
class
ADD-RESPONSE
```
 
```

class

`CALL`

Class to represent a call card in a play deck.

Call cards hold a list of string fragments as their text
property. Between each two adjacent fragment is a "gap"
that should be filled by a response card's text.

See CARD
See ADD-CALL

class

`CARD`

Class to represent a card in a play deck.

See TEXT

class

`CHANNEL`

Object representing a channel on a remote system somewhere.

Channels are virtual "rooms" over which one or more users may
communicate with each other.

Channels have a name and a number of users that inhabit it.
Additional properties are not guaranteed, but may be provided by a
client.

See CLIENT-ENTITY
See USERS

class
CREATE-DECK
```
 
```

class

`CRIMES`

This is an implementation of the popular Cards Against Humanity card game. It works by displaying the hands of the players in a private conversation. Picks and results are shown in a global channel. See 'open crimes' for how to start a game.

class

`DECK`

Container class for a deck of crimes cards.

It contains a table of call cards and a table of response cards.

See NAME
See TITLE
See CALLS
See RESPONSES

class
DOWNLOAD-DECK
```
 
```
class
END-GAME
```
 
```

class

`GAME`

Class to represent a game of Crimes.

This holds all the necessary state to play a game of
crimes.

See CHANNEL
See CALLS
See RESPONSES
See PLAYERS
See SCRAMBLED
See HAND-SIZE
See WIN-SCORE
See IN-SESSION
See ADD-DECK
See OFFICER
See START
See END
See JOIN
See LEAVE
See SUBMIT
See COMPLETE-P
See WINNER
See FINISH-ROUND
See NEXT-ROUND

class
JOIN-GAME
```
 
```
class
LEAVE-GAME
```
 
```
class
LIST-DECKS
```
 
```
class
OPEN-GAME
```
 
```

class

`PLAYER`

Class to represent a player in a game.

This keeps track of the associated user object, the game
they are playing in, the hand and score they have, and
their current response.

See USER
See GAME
See HAND
See SCORE
See RESULT
See COMPLETE-P
See REMAINING-RESPONSES
See DRAW-CARDS
See NEXT-ROUND

class
REMOVE-CARD
```
 
```
class
REMOVE-DECK
```
 
```

class

`RESPONSE`

Class to represent a response card in a play deck.

Response cards are used to fill the gaps in call cards.

See CARD
See ADD-RESPONSE

class

`RESULT`

Container class to represent a possible answer to a call.

Contains a single call card and a number of response cards
that should be used to fill the gaps in the call card.
Calling TEXT on a result will give the currently filled in
call card text as per the result cards entered into the result.

See CALL
See RESPONSES
See REQUIRED-RESPONSES
See REMAINING-RESPONSES
See COMPLETE-P
See ADD-RESPONSE
See TEXT

class
SEARCH-DECK
```
 
```
class
SELECT-WINNER
```
 
```
class
START
```
 
```
class
START-GAME
```
 
```
class
SUBMIT-CARD
```
 
```

class

`USER`

Object representing a user on a remote system somewhere.

Users have a name and may be authenticated. Additional properties
are not guaranteed, but may be provided by a client.

See CLIENT-ENTITY
See AUTHENTICATE
See AUTHENTICATED-P
See USERNAME

accessor (
CALL
OBJECT)
```
 
```

accessor (

`CALLS`

OBJECT)

Accessor to the table or list of call cards.

See DECK
See GAME
See CALL

accessor (

`CHANNEL`

OBJECT)

Accessor to the channel that the game is being played on.

See MAIDEN-CLIENT-ENTITIES:CHANNEL
See GAME

accessor (

`DECK`

NAME)

Acessor to the deck storage.

If a deck is attempted to be read that is not yet in the table,
it is attempted to be loaded from disk. When a deck is set, it
is automatically offloaded to disk.

See *DECKS*
See NORMALIZE-NAME
See LOAD-DECK

accessor (

`GAME`

OBJECT)

Accessor to the game object the player is part of.

See GAME
See PLAYER

accessor (
GAMES
OBJECT)
```
 
```

accessor (

`HAND`

OBJECT)

Accessor to the player's list of response cards they currently hold in their hand.

See PLAYER
See RESPONSE

accessor (

`HAND-SIZE`

OBJECT)

Accessor to the number of response cards every player should hold in their hand.

See GAME
See HAND

accessor (

`IN-SESSION`

OBJECT)

Accessor to whether the game is started or whether it's still in "lobby mode" and waiting for players to join.

See GAME

accessor (

`NAME`

OBJECT)

Aecessor to the name of the entity.

See NAMED-ENTITY

accessor (

`PLAYERS`

OBJECT)

Accessor to the list of players participating in this game.

See GAME
See JOIN
See LEAVE

accessor (

`RESPONSES`

OBJECT)

Accessor to the table or list of response cards.

See DECK
See GAME
See RESPONSE

accessor (

`RESULT`

OBJECT)

Accessor to the player's result response for the current round.

See PLAYER
See RESULT

accessor (

`SCORE`

OBJECT)

Accessor to the player's current score.

The score is the number of rounds that they've won.

See PLAYER

accessor (

`SCRAMBLED`

OBJECT)

Accessor to the list of index numbers for each player.

The list is in the same order as the players list and
associates a unique number to each player. This number
is used to represent the results in an anonymous manner
such that the person who played it cannot be determined.

See GAME

accessor (

`TEXT`

OBJECT)

Accessor to the text that the card holds.

The text may either be a direct string, or a list of
strings.

See CARD

accessor (

`TITLE`

OBJECT)

Accessor to the descriptive title of the card deck.

See DECK

accessor (

`USER`

OBJECT)

Reader for the user object the event relates to.

See USER-EVENT

accessor (

`WIN-SCORE`

OBJECT)

Accessor to the maximum score necessary for a player to win the game.

See GAME
See SCORE

function (

`CARDCAST/DECK`

DECK-ID)

Request information about a specific cardcast deck.

The returned result is the parsed JSON return value from the API.

See *CARDCAST/DECK*

function (

`CARDCAST/DECK/CARDS`

DECK-ID)

Request the card list for a specific deck from the cardcast server.

The returned result is the parsed JSON return value from the API.

See *CARDCAST/DECK/CARDS*

function (

`CARDCAST/DECKS`

&KEY (OFFSET 0) (LIMIT 20) SEARCH AUTHOR CATEGORY)

Search or list decks from the cardcast server.

The returned result is the parsed JSON return value from the API.

See *CARDCAST/DECKS*

function (

`FIND-CARDCAST-DECKS`

QUERY)

Returns a list of lists of name to deck id of matching decks for the given search query.

See CARDCAST/DECKS

function (

`LOAD-CARDCAST-DECK`

DECK-ID)

Load a deck from the cardcast server and parse it into a DECK instance.

See DECK
See CARDCAST/DECK
See CARDCAST/DECK/CARDS
See CARDCAST-LIST->MAP

function (

`LOAD-DECK`

NAME)

Load the given deck from disk if possible.

If no storage for the given deck can be found, an error
is signalled.

See DECK
See SAVE-DECK
See NORMALIZE-NAME
See MAIDEN-STORAGE:WITH-STORAGE

function (

`REMOVE-DECK`

NAME)

Completely remove the given deck.

The deck is both removed from the cached table, and from the
disk. It is not possible to recover it once the deck's instance
has been garbage collected.

See DECK

function (

`SAVE-DECK`

DECK)

Save the given deck to disk so that it can be restored later.

The deck's NAME is used as the storage designator.

See DECK
See LOAD-DECK
See MAIDEN-STORAGE:WITH-STORAGE

function (

`USER-GAME`

C EV &OPTIONAL (ERROR T))

Attempt to find the game for the user of the given event and client.

If no such game can be found, and ERROR is non-NIL,
an error is signalled.

generic (

`ADD-CALL`

CALL DECK)

Add a new call card to the deck.

See CALL
See CALLS
See PARSE-CALL

generic (

`ADD-DECK`

DECK GAME)

Add a deck of cards to the game's set.

If this is attempted to be done while the game is in
session, an error is signalled.

See DECK
See GAME

generic (

`ADD-RESPONSE`

RESPONSE DECK)

Add a new response card to the deck.

See RESPONSE
See RESPONSES

generic (

`CARD`

ID DECK)

Accessor to the card of the given ID in the deck.

See DECK
See CARD

generic (

`COMPLETE-P`

RESULT)

Returns whether the result is complete or needs more response cards.

See RESULT

generic (

`DRAW-CARDS`

PLAYER)

Draws new cards for the player until the hand has the necessary amount again.

See HAND-SIZE
See HAND
See GAME
See PLAYER

generic (

`END`

GAME)

End the game immediately.

See IN-SESSION
See GAME

generic (

`FINISH-ROUND`

WINNER GAME)

Finish the round by picking a winner.

An error is signalled if a player is picked that is
not participating in the game, or if the officer
picks themselves. The next round is started
automatically.

See NEXT-ROUND

generic (

`JOIN`

USER GAME)

Make a user join the game.

An error is signalled if the user is already playing.
If the game is already in session, the user will only
be participating in the next round.

See GAME
See LEAVE

generic (

`LEAVE`

USER GAME)

Make a user leave the game

The player's cards are re-added to the game's set and
if no more players are in the game, the game is
automatically ended.

See GAME
See JOIN

generic (

`LIST-CALLS`

DECK)

Return a fresh list of all call cards in the deck.

See CALLS
See CALL

generic (

`LIST-RESPONSES`

DECK)

Return a fresh list of all response cards in the deck.

See RESPONSES
See RESPONSE

generic (

`NEXT-ROUND`

PLAYER)

Advance the object to the next round of the game.

For a player this means redrawing cards into the hand,
putting the used up response cards back into the game
deck, and preparing a new response object.

For a game this means removing the current call card,
checking whether someone won the game by max score,
otherwise picking the next officer and scrambling the
numbers used for each player.

See PLAYER

generic (

`OFFICER`

GAME)

Returns the player who is currently designated as the officer in the game.

See PLAYER
See GAME

generic (

`REMAINING-RESPONSES`

RESULT)

Return the number of remaining response cards necessary to satisfy the result.

See RESULT

generic (

`REMOVE-CARD`

ID DECK)

Removes the card with the given ID from the deck.

See DECK

generic (

`REQUIRED-RESPONSES`

CALL)

Return the number of required response cards to properly fill this call card.

See CALL
See RESULT

generic (

`START`

EVENT-DELIVERY)

Start the event delivery and make it ready to accept and deliver events.

If the delivery is already running this does nothing.

generic (

`SUBMIT`

RESPONSE PLAYER GAME)

Submit a response on behalf of the player for the given game.

An error is signalled if:
- The response is not a card on the player's hand
- The player is currently the officer
- The response has already been submitted
- The index of the response is out of bounds

See PLAYER
See GAME
See ADD-RESPONSE
See RESULT

generic (

`WINNER`

GAME)

Returns the winner of the game if the game is complete and has any players to pick from.

The secondary value is the player's score.

command (

`add crime call`

DECK &REST TEXT)

Add a call card to a card deck. Use two or more underscores to signify the blanks that people should fill in.

command (

`add crimes deck`

NAME/ID)

Add a new card deck to the stack of the current game. This can only be done by players.

command (
add crime response
DECK &REST TEXT)
```
Add a response card to a card deck.
```

command (

`create crime deck`

NAME &OPTIONAL (TITLE ""))

Create a new card deck from scratch. Use 'add crime call' and 'add crime response' to add call and response cards respectively. Note that you can also download decks from cardcast with 'search for crime deck' and 'download crime deck'.

command (

`download crime deck`

ID &OPTIONAL NEW-NAME)

Download a crime deck from cardcastgame.com. You must supply the deck's ID. Use the website or the command 'search for crime deck' to find the ID of a deck.

command
end crimes
```
End the currently opened game early.
```

command

`join crimes`

Join the current crimes game session. You'll be entered as a new user and be shown your hand in a private conversation once the next round begins.

command

`leave crimes`

Leave the current crimes game session. You can also end the game entirely with 'end crimes'.

command

`list crime decks`

Show a list of the names of all locally available decks.

command (

`open crimes`

&KEY (WINNING-SCORE "7") (HAND-SIZE "10"))

Start a new game of crimes. You can specify the number of points necessary to win, and the number of cards for  each player. Once opened, add cards with 'add crimes deck' and enter the game with 'join crimes'. When everyone is ready, start the game proper with 'start crimes'.

command (

`remove crime card`

CARD DECK)

Remove a card from a card deck. The text must match exactly.

command (
remove crime deck
NAME)
```
Remove an existing card deck.
```

command (

`search for crime deck`

SEARCH)

Search for decks on CardCast. This will return a list of deck IDs that matched the query.

command (

`convict criminal`

WINNING-NUMBER)

Select the criminal who won the current round. Only the officer can do this.

command (

`start trivia game`

&REST CATEGORIES)

Start a new trivia game. You need to specify a number of categories from which questions can be selected. Users don't have to explicitly join. Whoever replies with the correct answer first wins the point.

command

`start crimes`

Actually start the opened game. Players can still enter later, while the game is running.

command (

`commit crime`

&REST CARDS)

Submit the selected card(s) as your pick for the current round. You can use this command multiple times, or supply multiple card numbers at once. You should do this in the private conversation. You cannot do this when you are the officer.

About Maiden-Crimes

How To

Copyright

Package Index

MAIDEN-CRIMES (ORG.SHIRAKUMO.MAIDEN.AGENTS.CRIMES)