This is the cl-modio Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:28:12 2024 GMT+0.
cl-modio/cl-modio.asdcl-modio/package.lispcl-modio/toolkit.lispcl-modio/client.lispcl-modio/objects.lispcl-modio/cache.lispcl-modio/authentication.lispcl-modio/me.lispcl-modio/games.lispcl-modio/mods.lispcl-modio/files.lispcl-modio/subscribe.lispcl-modio/comments.lispcl-modio/media.lispcl-modio/events.lispcl-modio/tags.lispcl-modio/ratings.lispcl-modio/stats.lispcl-modio/metadata.lispcl-modio/dependencies.lispcl-modio/teams.lispcl-modio/general.lispcl-modio/reports.lispcl-modio/simple.lispcl-modio/documentation.lispThe main system appears first, followed by any subsystem dependency.
cl-modioA client library for the mod.io API.
Yukari Hafner <shinmera@tymoon.eu>
Yukari Hafner <shinmera@tymoon.eu>
zlib
1.0.0
alexandria (system).
uiop (system).
zippy (system).
com.inuoe.jzon (system).
cl-ppcre (system).
drakma (system).
documentation-utils (system).
language-codes (system).
package.lisp (file).
toolkit.lisp (file).
client.lisp (file).
objects.lisp (file).
cache.lisp (file).
authentication.lisp (file).
me.lisp (file).
games.lisp (file).
mods.lisp (file).
files.lisp (file).
subscribe.lisp (file).
comments.lisp (file).
media.lisp (file).
events.lisp (file).
tags.lisp (file).
ratings.lisp (file).
stats.lisp (file).
metadata.lisp (file).
dependencies.lisp (file).
teams.lisp (file).
general.lisp (file).
reports.lisp (file).
simple.lisp (file).
documentation.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-modio/cl-modio.asdcl-modio/package.lispcl-modio/toolkit.lispcl-modio/client.lispcl-modio/objects.lispcl-modio/cache.lispcl-modio/authentication.lispcl-modio/me.lispcl-modio/games.lispcl-modio/mods.lispcl-modio/files.lispcl-modio/subscribe.lispcl-modio/comments.lispcl-modio/media.lispcl-modio/events.lispcl-modio/tags.lispcl-modio/ratings.lispcl-modio/stats.lispcl-modio/metadata.lispcl-modio/dependencies.lispcl-modio/teams.lispcl-modio/general.lispcl-modio/reports.lispcl-modio/simple.lispcl-modio/documentation.lispcl-modio/toolkit.lisppackage.lisp (file).
cl-modio (system).
*portal* (special variable).
detect-platform (function).
detect-portal (function).
f (macro).
id (method).
%make-filter (function).
api-access-options-id (function).
community-options-id (function).
curation-option-id (function).
define-id-group (macro).
define-id-map (macro).
define-parsable-class (macro).
define-print-method (macro).
delete-directory (function).
enlist (function).
event-type-id (function).
expiry-timestamp (function).
extract-metadata (function).
fill-object-from-data (generic function).
filter (structure).
filter-comparator (reader).
(setf filter-comparator) (writer).
filter-from-keywords (function).
filter-invert (reader).
(setf filter-invert) (writer).
filter-value (reader).
(setf filter-value) (writer).
format-time (function).
game-tag-type-id (function).
id-api-access-options (function).
id-community-options (function).
id-curation-option (function).
id-event-type (function).
id-game-tag-type (function).
id-invite (function).
id-level (function).
id-maturity-options (function).
id-presentation-option (function).
id-rating (function).
id-report-type (function).
id-resource-type (function).
id-revenue-options (function).
id-status (function).
id-submission-option (function).
id-virus-positive (function).
id-virus-status (function).
id-visibility (function).
invite-id (function).
level-id (function).
make-temp-file (function).
maturity-options-id (function).
or* (function).
presentation-option-id (function).
rating-id (function).
report-type-id (function).
resource-type-id (function).
revenue-options-id (function).
status-id (function).
submission-option-id (function).
tabkey (function).
tempdir (function).
to-parameter-name (function).
universal-timestamp (function).
unix-timestamp (function).
unlist (function).
update-value (function).
virus-positive-id (function).
virus-status-id (function).
visibility-id (function).
cl-modio/client.lisptoolkit.lisp (file).
cl-modio (system).
*base-url* (special variable).
*client* (special variable).
*debug* (special variable).
access-token (reader method).
(setf access-token) (writer method).
account-banned (condition).
account-deleted (condition).
api-key (reader method).
(setf api-key) (writer method).
arguments (reader method).
authenticated-p (method).
bad-request (condition).
cache (reader method).
(setf cache) (writer method).
client (class).
comment-not-found (condition).
data (reader method).
default-game-id (reader method).
(setf default-game-id) (writer method).
direct-request (function).
endpoint (reader method).
error-code (reader method).
extract-user-properties (method).
game-not-found (condition).
invalid-access-key (condition).
language (reader method).
(setf language) (writer method).
make-load-form (method).
message (reader method).
mod-deleted (condition).
mod-not-found (condition).
modfile-not-found (condition).
modio-condition (condition).
on-rate-limit (reader method).
(setf on-rate-limit) (writer method).
permission-denied (condition).
platform (reader method).
(setf platform) (writer method).
portal (reader method).
(setf portal) (writer method).
print-object (method).
request (method).
request-error (condition).
request-list (method).
resource-already-exists (condition).
resource-not-found (condition).
restore-user-properties (method).
server-error (condition).
service-unavailable (condition).
too-many-requests (condition).
user-not-found (condition).
valid-until (reader method).
(setf valid-until) (writer method).
wait-until (reader method).
(setf wait-until) (writer method).
define-edit-endpoint (macro).
define-endpoint (macro).
define-list-endpoint (macro).
define-list-endpoint* (macro).
process-filter (function).
process-headers (function).
process-parameter-value (function).
process-parameters (function).
process-sort (function).
cl-modio/objects.lispclient.lisp (file).
cl-modio (system).
api-access (reader method).
avatar (reader method).
binary-url (reader method).
changelog (reader method).
comment (class).
community (reader method).
content (reader method).
curation (reader method).
date-added (reader method).
date-added (reader method).
date-added (reader method).
date-added (reader method).
date-added (reader method).
date-added (reader method).
date-added (reader method).
date-added (reader method).
date-added (reader method).
date-added (reader method).
date-expires (reader method).
date-expires (reader method).
date-expires (reader method).
date-live (reader method).
date-live (reader method).
date-scanned (reader method).
date-updated (reader method).
date-updated (reader method).
description (reader method).
description-html (reader method).
display-name (reader method).
download (reader method).
download (class).
downloads (reader method).
downloads (reader method).
event-type (reader method).
event-type (reader method).
file-hash (reader method).
file-name (reader method).
file-name (reader method).
file-size (reader method).
game (method).
game (class).
game-id (reader method).
game-id (reader method).
game-id (reader method).
game-id (reader method).
game-id (reader method).
(setf game-id) (writer method).
game-resource (class).
game-stats (class).
game-tag-option (class).
header (reader method).
hidden (reader method).
homepage-url (reader method).
icon (reader method).
id (reader method).
id (reader method).
id (reader method).
id (reader method).
id (reader method).
id (reader method).
id (reader method).
id (reader method).
id (reader method).
(setf id) (writer method).
image (class).
images (reader method).
instructions (reader method).
instructions-url (reader method).
invite (reader method).
karma (reader method).
last-online (reader method).
level (reader method).
locked (reader method).
logo (reader method).
logo (reader method).
maturity (reader method).
maturity (reader method).
media (reader method).
metadata (reader method).
metadata-blob (reader method).
metadata-blob (reader method).
mod (method).
mod (class).
mod-dependency (class).
mod-event (class).
mod-id (reader method).
mod-id (reader method).
mod-id (reader method).
mod-id (reader method).
mod-id (reader method).
mod-id (reader method).
mod-id (reader method).
mod-id (reader method).
(setf mod-id) (writer method).
mod-media (class).
mod-resource (class).
mod-stats (class).
mod-tag (class).
modfile (reader method).
modfile (class).
mods (reader method).
name (reader method).
name (reader method).
name (reader method).
name (reader method).
name (reader method).
name (reader method).
name (reader method).
(setf name) (writer method).
name-id (reader method).
name-id (reader method).
name-id (reader method).
name-id (reader method).
(setf name-id) (writer method).
named-resource (class).
original (reader method).
popularity (reader method).
presentation (reader method).
print-object (method).
print-object (method).
profile-url (reader method).
profile-url (reader method).
profile-url (reader method).
rating (reader method).
rating (reader method).
rating (class).
reply (method).
reply-id (reader method).
revenue (reader method).
sketchfab-urls (reader method).
stats (reader method).
stats (reader method).
status (reader method).
status (reader method).
submission (reader method).
submitted-by (reader method).
submitted-by (reader method).
subscribers (reader method).
subscribers (reader method).
summary (reader method).
summary (reader method).
tag-count (reader method).
tag-options (reader method).
tag-type (reader method).
tags (reader method).
tags (reader method).
team-member (class).
thread-position (reader method).
thumbnails (reader method).
title (reader method).
ugc-name (reader method).
unique-resource (class).
user (reader method).
user (method).
user (method).
user (method).
user (reader method).
user (class).
user-event (class).
user-id (reader method).
user-id (reader method).
user-id (reader method).
(setf user-id) (writer method).
user-resource (class).
version (reader method).
virus-hash (reader method).
virus-positive (reader method).
virus-status (reader method).
visible (reader method).
youtube-urls (reader method).
fill-object-from-data (method).
fill-object-from-data (method).
fill-object-from-data (method).
fill-object-from-data (method).
fill-object-from-data (method).
fill-object-from-data (method).
fill-object-from-data (method).
fill-object-from-data (method).
fill-object-from-data (method).
fill-object-from-data (method).
fill-object-from-data (method).
fill-object-from-data (method).
fill-object-from-data (method).
fill-object-from-data (method).
fill-object-from-data (method).
fill-object-from-data (method).
fill-object-from-data (method).
fill-object-from-data (method).
cl-modio/cache.lispobjects.lisp (file).
cl-modio (system).
cache (structure).
clear-cache (method).
clear-cache (method).
games/get (method).
games/get (method).
games/mods/comments/get (method).
games/mods/comments/get (method).
games/mods/files/get (method).
games/mods/files/get (method).
games/mods/get (method).
games/mods/get (method).
valid-p (generic function).
cache-listing (method).
cache-listing (method).
cache-lists (reader).
(setf cache-lists) (writer).
cache-object (method).
cache-object (method).
cache-objects (reader).
(setf cache-objects) (writer).
get-listing (method).
get-listing (method).
make-cache (function).
cl-modio/authentication.lispcache.lisp (file).
cl-modio (system).
authenticate/discord (method).
authenticate/discord (method).
authenticate/email-exchange (method).
authenticate/email-exchange (method).
authenticate/email-request (method).
authenticate/email-request (method).
authenticate/epic (method).
authenticate/epic (method).
authenticate/gog-galaxy (method).
authenticate/gog-galaxy (method).
authenticate/google (method).
authenticate/google (method).
authenticate/itchio (method).
authenticate/itchio (method).
authenticate/logout (method).
authenticate/logout (method).
authenticate/oculus (method).
authenticate/oculus (method).
authenticate/openid (method).
authenticate/openid (method).
authenticate/steam (method).
authenticate/steam (method).
authenticate/switch (method).
authenticate/switch (method).
authenticate/terms (method).
authenticate/terms (method).
authenticate/xbox (method).
authenticate/xbox (method).
complete-authentication (method).
cl-modio/me.lispauthentication.lisp (file).
cl-modio (system).
me (method).
me (method).
me/events (method).
me/files (method).
me/games (method).
me/mods (method).
me/ratings (method).
me/subscribed (method).
cl-modio/games.lispme.lisp (file).
cl-modio (system).
games (method).
games/edit (method).
games/edit (method).
games/get (method).
games/get (method).
cl-modio/mods.lispgames.lisp (file).
cl-modio (system).
games/mods (method).
games/mods/add (method).
games/mods/add (method).
games/mods/delete (method).
games/mods/delete (method).
games/mods/edit (method).
games/mods/edit (method).
games/mods/get (method).
games/mods/get (method).
cl-modio/files.lispmods.lisp (file).
cl-modio (system).
download-corrupted (condition).
download-modfile (method).
extract-modfile (method).
file-size (reader method).
games/mods/files (method).
games/mods/files/add (method).
games/mods/files/add (method).
games/mods/files/delete (method).
games/mods/files/delete (method).
games/mods/files/edit (method).
games/mods/files/edit (method).
games/mods/files/get (method).
games/mods/files/get (method).
modfile (reader method).
modfile-error (condition).
target (reader method).
target-already-exists (condition).
target-does-not-exist (condition).
cl-modio/subscribe.lispfiles.lisp (file).
cl-modio (system).
games/mods/subscribe (method).
games/mods/subscribe (method).
games/mods/unsubscribe (method).
games/mods/unsubscribe (method).
cl-modio/comments.lispsubscribe.lisp (file).
cl-modio (system).
games/mods/comments (method).
games/mods/comments/add (method).
games/mods/comments/add (method).
games/mods/comments/delete (method).
games/mods/comments/delete (method).
games/mods/comments/edit (method).
games/mods/comments/edit (method).
games/mods/comments/get (method).
games/mods/comments/get (method).
cl-modio/media.lispcomments.lisp (file).
cl-modio (system).
games/media/add (method).
games/media/add (method).
games/mods/media/add (method).
games/mods/media/add (method).
games/mods/media/delete (method).
games/mods/media/delete (method).
cl-modio/events.lispmedia.lisp (file).
cl-modio (system).
games/mods/events (method).
games/mods/mod-events (method).
cl-modio/tags.lispevents.lisp (file).
cl-modio (system).
games/mods/tags (method).
games/mods/tags/add (method).
games/mods/tags/add (method).
games/mods/tags/delete (method).
games/mods/tags/delete (method).
games/tags (method).
games/tags/add (method).
games/tags/add (method).
games/tags/delete (method).
games/tags/delete (method).
cl-modio/ratings.lisptags.lisp (file).
cl-modio (system).
games/mods/ratings/add (method).
games/mods/ratings/add (method).
cl-modio/stats.lispratings.lisp (file).
cl-modio (system).
games/mods/stats (method).
games/mods/stats (method).
games/mods/stats/all (method).
games/stats (method).
games/stats (method).
cl-modio/metadata.lispstats.lisp (file).
cl-modio (system).
games/mods/metadata (method).
games/mods/metadata/add (method).
games/mods/metadata/add (method).
games/mods/metadata/delete (method).
games/mods/metadata/delete (method).
cl-modio/dependencies.lispmetadata.lisp (file).
cl-modio (system).
games/mods/dependencies (method).
games/mods/dependencies/add (method).
games/mods/dependencies/add (method).
games/mods/dependencies/delete (method).
games/mods/dependencies/delete (method).
cl-modio/teams.lispdependencies.lisp (file).
cl-modio (system).
games/mods/team (method).
games/mods/team/add (method).
games/mods/team/add (method).
games/mods/team/delete (method).
games/mods/team/delete (method).
games/mods/team/edit (method).
games/mods/team/edit (method).
cl-modio/general.lispteams.lisp (file).
cl-modio (system).
general/ownership (method).
general/ownership (method).
cl-modio/reports.lispgeneral.lisp (file).
cl-modio (system).
cl-modio/simple.lispreports.lisp (file).
cl-modio (system).
determine-mod-properties (method).
download-modfile (method).
download-modfile (method).
extract-modfile (method).
extract-modfile (method).
find-modfile (method).
load-local-modlist (method).
load-remote-modlist (method).
mod-directory (method).
modfile-cache-directory (method).
modlist-file (method).
mods-directory (reader method).
(setf mods-directory) (writer method).
simple-client (class).
sync-modlist-from-remote (method).
sync-modlist-to-remote (method).
update-local-mods (method).
write-local-modlist (method).
normalize-modlist-entry (function).
cl-modio/documentation.lispsimple.lisp (file).
cl-modio (system).
Packages are listed by definition order.
org.shirakumo.fraf.modiocommon-lisp.
*base-url* (special variable).
*client* (special variable).
*debug* (special variable).
*portal* (special variable).
access-token (generic reader).
(setf access-token) (generic writer).
account-banned (condition).
account-deleted (condition).
api-access (generic reader).
api-key (generic reader).
(setf api-key) (generic writer).
arguments (generic reader).
authenticate/discord (generic function).
authenticate/email-exchange (generic function).
authenticate/email-request (generic function).
authenticate/epic (generic function).
authenticate/gog-galaxy (generic function).
authenticate/google (generic function).
authenticate/itchio (generic function).
authenticate/logout (generic function).
authenticate/oculus (generic function).
authenticate/openid (generic function).
authenticate/steam (generic function).
authenticate/switch (generic function).
authenticate/terms (generic function).
authenticate/xbox (generic function).
authenticated-p (generic function).
avatar (generic reader).
bad-request (condition).
binary-url (generic reader).
cache (generic reader).
(setf cache) (generic writer).
cache (structure).
changelog (generic reader).
clear-cache (generic function).
client (class).
comment (class).
comment-not-found (condition).
community (generic reader).
complete-authentication (generic function).
content (generic reader).
curation (generic reader).
data (generic reader).
date-added (generic reader).
date-expires (generic reader).
date-live (generic reader).
date-scanned (generic reader).
date-updated (generic reader).
default-game-id (generic reader).
(setf default-game-id) (generic writer).
description (generic reader).
description-html (generic reader).
detect-platform (function).
detect-portal (function).
determine-mod-properties (generic function).
direct-request (function).
display-name (generic reader).
download (generic reader).
download (class).
download-corrupted (condition).
download-modfile (generic function).
downloads (generic reader).
endpoint (generic reader).
error-code (generic reader).
event-type (generic reader).
extract-modfile (generic function).
extract-user-properties (generic function).
f (macro).
file-hash (generic reader).
file-name (generic reader).
file-size (generic reader).
find-modfile (generic function).
game (generic function).
game (class).
game-id (generic reader).
(setf game-id) (generic writer).
game-not-found (condition).
game-resource (class).
game-stats (class).
game-tag-option (class).
games (generic function).
games/edit (generic function).
games/get (generic function).
games/media/add (generic function).
games/mods (generic function).
games/mods/add (generic function).
games/mods/comments (generic function).
games/mods/comments/add (generic function).
games/mods/comments/delete (generic function).
games/mods/comments/edit (generic function).
games/mods/comments/get (generic function).
games/mods/delete (generic function).
games/mods/dependencies (generic function).
games/mods/dependencies/add (generic function).
games/mods/dependencies/delete (generic function).
games/mods/edit (generic function).
games/mods/events (generic function).
games/mods/files (generic function).
games/mods/files/add (generic function).
games/mods/files/delete (generic function).
games/mods/files/edit (generic function).
games/mods/files/get (generic function).
games/mods/get (generic function).
games/mods/media/add (generic function).
games/mods/media/delete (generic function).
games/mods/metadata (generic function).
games/mods/metadata/add (generic function).
games/mods/metadata/delete (generic function).
games/mods/mod-events (generic function).
games/mods/ratings/add (generic function).
games/mods/stats (generic function).
games/mods/stats/all (generic function).
games/mods/subscribe (generic function).
games/mods/tags (generic function).
games/mods/tags/add (generic function).
games/mods/tags/delete (generic function).
games/mods/team (generic function).
games/mods/team/add (generic function).
games/mods/team/delete (generic function).
games/mods/team/edit (generic function).
games/mods/unsubscribe (generic function).
games/stats (generic function).
games/tags (generic function).
games/tags/add (generic function).
games/tags/delete (generic function).
general/ownership (generic function).
header (generic reader).
hidden (generic reader).
homepage-url (generic reader).
icon (generic reader).
id (generic function).
(setf id) (generic writer).
image (class).
images (generic reader).
instructions (generic reader).
instructions-url (generic reader).
invalid-access-key (condition).
invite (generic reader).
karma (generic reader).
language (generic reader).
(setf language) (generic writer).
last-online (generic reader).
level (generic reader).
load-local-modlist (generic function).
load-remote-modlist (generic function).
locked (generic reader).
logo (generic reader).
maturity (generic reader).
me (generic function).
me/events (generic function).
me/files (generic function).
me/games (generic function).
me/mods (generic function).
me/ratings (generic function).
me/subscribed (generic function).
media (generic reader).
message (generic reader).
metadata (generic reader).
metadata-blob (generic reader).
mod (generic function).
mod (class).
mod-deleted (condition).
mod-dependency (class).
mod-directory (generic function).
mod-event (class).
mod-id (generic reader).
(setf mod-id) (generic writer).
mod-media (class).
mod-not-found (condition).
mod-resource (class).
mod-stats (class).
mod-tag (class).
modfile (generic reader).
modfile (class).
modfile-cache-directory (generic function).
modfile-error (condition).
modfile-not-found (condition).
modio-condition (condition).
modlist-file (generic function).
mods (generic reader).
mods-directory (generic reader).
(setf mods-directory) (generic writer).
name (generic reader).
(setf name) (generic writer).
name-id (generic reader).
(setf name-id) (generic writer).
named-resource (class).
on-rate-limit (generic reader).
(setf on-rate-limit) (generic writer).
original (generic reader).
permission-denied (condition).
platform (generic reader).
(setf platform) (generic writer).
popularity (generic reader).
portal (generic reader).
(setf portal) (generic writer).
presentation (generic reader).
profile-url (generic reader).
rating (generic reader).
rating (class).
reply (generic function).
reply-id (generic reader).
report (generic function).
request (generic function).
request-error (condition).
request-list (generic function).
resource-already-exists (condition).
resource-not-found (condition).
restore-user-properties (generic function).
revenue (generic reader).
server-error (condition).
service-unavailable (condition).
simple-client (class).
sketchfab-urls (generic reader).
stats (generic reader).
status (generic reader).
submission (generic reader).
submitted-by (generic reader).
subscribers (generic reader).
summary (generic reader).
sync-modlist-from-remote (generic function).
sync-modlist-to-remote (generic function).
tag-count (generic reader).
tag-options (generic reader).
tag-type (generic reader).
tags (generic reader).
target (generic reader).
target-already-exists (condition).
target-does-not-exist (condition).
team-member (class).
thread-position (generic reader).
thumbnails (generic reader).
title (generic reader).
too-many-requests (condition).
ugc-name (generic reader).
unique-resource (class).
update-local-mods (generic function).
user (generic function).
user (class).
user-event (class).
user-id (generic reader).
(setf user-id) (generic writer).
user-not-found (condition).
user-resource (class).
valid-p (generic function).
valid-until (generic reader).
(setf valid-until) (generic writer).
version (generic reader).
virus-hash (generic reader).
virus-positive (generic reader).
virus-status (generic reader).
visible (generic reader).
wait-until (generic reader).
(setf wait-until) (generic writer).
write-local-modlist (generic function).
youtube-urls (generic reader).
%make-filter (function).
api-access-options-id (function).
cache-listing (generic function).
cache-lists (reader).
(setf cache-lists) (writer).
cache-object (generic function).
cache-objects (reader).
(setf cache-objects) (writer).
community-options-id (function).
curation-option-id (function).
define-edit-endpoint (macro).
define-endpoint (macro).
define-id-group (macro).
define-id-map (macro).
define-list-endpoint (macro).
define-list-endpoint* (macro).
define-parsable-class (macro).
define-print-method (macro).
delete-directory (function).
enlist (function).
event-type-id (function).
expiry-timestamp (function).
extract-metadata (function).
fill-object-from-data (generic function).
filter (structure).
filter-comparator (reader).
(setf filter-comparator) (writer).
filter-from-keywords (function).
filter-invert (reader).
(setf filter-invert) (writer).
filter-value (reader).
(setf filter-value) (writer).
format-time (function).
game-tag-type-id (function).
get-listing (generic function).
id-api-access-options (function).
id-community-options (function).
id-curation-option (function).
id-event-type (function).
id-game-tag-type (function).
id-invite (function).
id-level (function).
id-maturity-options (function).
id-presentation-option (function).
id-rating (function).
id-report-type (function).
id-resource-type (function).
id-revenue-options (function).
id-status (function).
id-submission-option (function).
id-virus-positive (function).
id-virus-status (function).
id-visibility (function).
invite-id (function).
level-id (function).
make-cache (function).
make-temp-file (function).
maturity-options-id (function).
normalize-modlist-entry (function).
or* (function).
presentation-option-id (function).
process-filter (function).
process-headers (function).
process-parameter-value (function).
process-parameters (function).
process-sort (function).
rating-id (function).
report-type-id (function).
resource-type-id (function).
revenue-options-id (function).
status-id (function).
submission-option-id (function).
tabkey (function).
tempdir (function).
to-parameter-name (function).
universal-timestamp (function).
unix-timestamp (function).
unlist (function).
update-value (function).
virus-positive-id (function).
virus-status-id (function).
visibility-id (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Holds the base URL API requests are made against.
Defaults to https://api.mod.io/v1/
Holds the current CLIENT instance.
See CLIENT (type)
If T, request information is printed to *debug-io*
See CL:*DEBUG-IO*
Variable holding the current portal.
Should be one of:
:Apple
:Discord
:EGS
:Facebook
:GOG
:Google
:Itchio
:Nintendo
:OpenID
:PSN
:Steam
:XboxLive
If NIL, the portal is auto-detected instead.
See DETECT-PORTAL
Construct a filter from the given filtering expression.
EXPR ::= NOT | SEARCH | BASIC
NOT ::= (not SEARCH | BASIC)
SEARCH ::= (search query)
BASIC ::= (FILTER comparison PARAMETER)
FILTER ::= equal | find | equalp | max | min | logand
PARAMETER — The name of an API parameter.
Returns the current platform we’re on.
Should be one of:
:windows
:linux
:mac
:android
:ios
:xboxone
:xboxseriesx
:ps4
:ps5
:switch
:wii
Returns the current portal we’re connected to.
If *portal* is not NIL, returns *portal*. Otherwise if
cl-steamworks is loaded and available, :steam is returned.
Otherwise NIL is returned.
See *PORTAL*
Function used to create a request.
Handles data conversion and error conversion.
If PREPEND-BASE is T, *BASE-URL* is prepended to ENDPOINT.
If PARSE is T, the response is parsed as JSON and returned.
Otherwise the raw stream is returned.
See REQUEST-ERROR
Accesses the access token by which the client connects to the API.
See CLIENT (type)
Accesses the api-access options of the game.
Can be a list composed of:
:3RD-PARTIES-ALLOWED
:DIRECT-DOWNLOAD-ALLOWED
See GAME (type)
Accesses the API key by which the client connects to the API.
See CLIENT (type)
Returns the arguments that were passed to the endpoint that failed.
See REQUEST-ERROR
request-error)) ¶Authenticate against Discord using the given auth token.
See COMPLETE-AUTHENTICATION
See CLIENT (type)
Completes an email login flow.
See COMPLETE-AUTHENTICATION See CLIENT (type)
Initiates an email login flow.
See CLIENT (type)
Authenticate against epic using an access token.
See COMPLETE-AUTHENTICATION
See CLIENT (type)
Authenticate against GOG Galaxy using the app data.
See COMPLETE-AUTHENTICATION
See CLIENT (type)
Authenticate against Google using the given auth token.
See COMPLETE-AUTHENTICATION
See CLIENT (type)
Authenticate against Itch.io using an access token.
See COMPLETE-AUTHENTICATION
See CLIENT (type)
Invalidate the access-token of the client and log out.
See CLIENT (type)
Authenticate against Oculus with the given device identification.
See COMPLETE-AUTHENTICATION
See CLIENT (type)
Authenticate against an OpenID provider using the given id-token.
See COMPLETE-AUTHENTICATION
See CLIENT (type)
Authenticate against steam using an encrypted app ticket.
See COMPLETE-AUTHENTICATION
See CLIENT (type)
Authenticate against Switch Online using the given auth token.
See COMPLETE-AUTHENTICATION
See CLIENT (type)
Returns the authentication terms you must show to the user for third-party authentication.
See CLIENT (type)
Authenticate against Xbox using the given auth token.
See COMPLETE-AUTHENTICATION
See CLIENT (type)
Returns true if the client is authenticated and the authentication token is still valid.
See CLIENT (type)
Accesses the user’s avatar IMAGE object.
See USER (type)
See IMAGE (type)
Accesses the URL at which the download can be accessed.
See DOWNLOAD (type)
Accesses the internal cache of the client.
See CACHE (type)
See CLIENT (type)
Accesses the changelog of the mod payload.
See MODFILE (type)
Clears the cache completely.
See CACHE (type)
See CLIENT (type)
Accesses the community options of the game.
Can be a list composed of:
:COMMENTS
:GUIDES
:DISABLE-SUBSCRIBE-TEXT
See GAME (type)
Function called when authentication completes successfully.
You may define secondary methods on this function to react to a
successful login.
See CLIENT (type)
Accesses the text content of the comment.
See COMMENT (type)
Accesses the curation option of the game.
Can be one of:
:NONE
:PAID
:FULL
See GAME (type)
Returns the raw JSON data payload the failure returned, if any.
See REQUEST-ERROR
request-error)) ¶data.
Returns the timestamp at which the object was added.
See COMMENT (type)
See GAME (type)
See MOD-DEPENDENCY (type)
See MOD-EVENT (type)
See MOD (type)
See MOD-TAG (type)
See MODFILE (type)
See RATING (type)
See USER-EVENT (type)
user-event)) ¶automatically generated reader method
team-member)) ¶automatically generated reader method
rating)) ¶automatically generated reader method
modfile)) ¶automatically generated reader method
mod-tag)) ¶automatically generated reader method
mod-event)) ¶automatically generated reader method
mod-dependency)) ¶automatically generated reader method
Accesses the timestamp after which the object is no longer valid.
See VALID-P
See DOWNLOAD (type)
See GAME-STATS (type)
See MOD-STATS (type)
mod-stats)) ¶automatically generated reader method
game-stats)) ¶automatically generated reader method
Accesses the timestamp at which this object was made available publicly.
See GAME (type)
See MOD (type)
Accesses the timestamp at which the file was scanned.
Accesses the timestamp at which this object was last updated.
See GAME (type)
See MOD (type)
Accesses the default ID of the game you want to interact with.
See CLIENT (type)
Accesses the plaintext description of the mod.
See MOD (type)
Accesses the rich HTML text description of the mod.
See MOD (type)
Attempt to discover information about the mod by parsing any ASD files within.
See SIMPLE-CLIENT (type)
simple-client) target) ¶Accesses the preferred display name of the user.
You should use this name instead of the raw account name to display to
other users.
See USER (type)
Accesses the download object of the modfile.
See MODFILE (type)
See DOWNLOAD (type)
Downloads the given modfile to disk.
IF-EXISTS may be the following:
:SUPERSEDE — The file is overwritten if the remote modfile is newer.
:OVERWRITE — The file is always overwritten.
:ERROR — An error of type TARGET-ALREADY-EXISTS is signalled.
:RETURN — The TARGET is returned with no modifications.
NIL — NIL is returned with no modifications.
IF-DOES-NOT-EXIST may be the following:
:CREATE — The file is downloaded.
:ERROR — An error of type TARGET-DOES-NOT-EXIST is signalled.
NIL — NIL is returned with no modifications.
See CLIENT (type)
Accesses the download statistics of the object.
Should be a plist with the following keys:
:TODAY
:TOTAL
:DAILY
See GAME-STATS (type)
See MOD-STATS (type)
mod-stats)) ¶automatically generated reader method
game-stats)) ¶automatically generated reader method
Returns the endpoint that failed.
See REQUEST-ERROR
request-error)) ¶Returns the error-code that was returned for the failure.
See REQUEST-ERROR
request-error)) ¶Accesses the type of the event described.
Can be one of:
:JOIN
:LEAVE
:SUBSCRIBE
:UNSUBSCRIBE
:FILE-CHANGED
:AVAILABLE
:UNAVAILABLE
:EDITED
:DELETED
:TEAM-CHANGED
See MOD-EVENT (type)
See USER-EVENT (type)
user-event)) ¶automatically generated reader method
Extract the given modfile contents to disk.
First calls DOWNLOAD-MODFILE with :IF-EXISTS :SUPERSEDE and
:IF-DOES-NOT-EXIST IF-NO-CACHE.
IF-EXISTS may be one of the following:
:SUPERSEDE — The target directory is deleted and the contents are
extracted anew. Note if you do not want it to delete
the directory, use :OVERWRITE instead.
:OVERWRITE — Overwrite the target directory contents with the new
files, leaving old files intact.
:ERROR — Signal an error of type TARGET-ALREADY-EXISTS.
NIL — NIL is returned with no modifications.
See DOWNLOAD-MODFILE
See CLIENT (type)
Returns a form that can be serialised to persist the client’s current settings.
See RESTORE-USER-PROPERTIES
See CLIENT (type)
Accesses the MD5 hash of the mod payload.
See MODFILE (type)
Accesses the original file name of the mod payload.
See MODFILE (type)
Accesses the size of the mod payload in bytes.
See MODFILE (type)
download-corrupted)) ¶Attempt to find a matching remote modfile of the given specs.
See MODFILE (type)
See SIMPLE-CLIENT (type)
simple-client) mod-id &key file-id version) ¶Returns the GAME object this object is associated with.
See GAME (type)
See GAME-RESOURCE (type)
game-resource)) ¶Accesses the ID of the GAME this object is associated with.
See GAME-RESOURCE (type)
user-event)) ¶automatically generated reader method
game-stats)) ¶automatically generated reader method
game-resource)) ¶automatically generated reader method
game-resource)) ¶automatically generated writer method
Returns a list of matching games.
See GAME (type)
See CLIENT (type)
Updates the given game object.
See GAME (type)
See CLIENT (type)
Returns the requested game object.
See GAME (type)
See CLIENT (type)
Uploads a media file to a game.
See CLIENT (type)
Returns a list of matching mods for the game.
See MOD (type)
See CLIENT (type)
Creates a new mod object on the game.
See MOD (type)
See CLIENT (type)
Returns a list of COMMENT objects on the given mod.
See COMMENT (type)
See CLIENT (type)
Creates a new comment.
See COMMENT (type) See CLIENT (type)
Deletes an existing comment.
See COMMENT (type)
See CLIENT (type)
Updates an existing comment.
See COMMENT (type)
See CLIENT (type)
Returns the requested comment.
See COMMENT (type)
See CLIENT (type)
(eql t)) game mod comment &rest args) ¶client) game mod (id integer) &key ignore-cache) ¶Deletes the given mod object.
See MOD (type)
See CLIENT (type)
Returns a list of dependencies for the given mod.
See MOD-DEPENDENCY (type)
See CLIENT (type)
Adds new dependencies to the given mod.
See CLIENT (type)
Removes dependencies from the given mod.
See CLIENT (type)
Updates the given mod object.
See MOD (type)
See CLIENT (type)
Returns a list of events for the game.
See GAME-EVENT (type)
See CLIENT (type)
Returns a list of modfiles of the given mod.
See MODFILE (type)
See CLIENT (type)
Creates a new modfile object.
See MODFILE (type)
See CLIENT (type)
Deletes the given modfile object.
See MODFILE (type)
See CLIENT (type)
Updates the given modfile object.
See MODFILE (type)
See CLIENT (type)
Returns the requested modfile object.
See MODFILE (type)
See CLIENT (type)
(eql t)) game mod file &rest args) ¶client) game mod (id integer) &key ignore-cache) ¶Returns the requested mod object.
See MOD (type)
See CLIENT (type)
Uploads a new media file to a mod.
See CLIENT (type)
Deletes an existing media file from a mod.
See CLIENT (type)
Returns the table of metadata on the given mod.
See CLIENT (type)
Adds or updates an existing metadata key on the given mod.
See CLIENT (type)
Deletes an existing metadata key from the given mod.
See CLIENT (type)
Returns a list of events for the mod.
See MOD-EVENT (type)
See CLIENT (type)
Adds or updates a rating on a mod.
See CLIENT (type)
Returns the stats object for the given mod.
See MOD-STATS (type)
See CLIENT (type)
Returns a list of stats about the mods in the game
See MOD-STATS (type)
See CLIENT (type)
Subscribe the current user to the given mod.
See CLIENT (type)
Returns a list of tags for the mod.
See MOD-TAG
See CLIENT (type)
Adds a new tag to the mod.
See CLIENT (type)
Deletes an existing tag from a mod.
See CLIENT (type)
Returns a list of all team members of the given mod.
See TEAM-MEMBER (type)
See CLIENT (type)
Adds a new team member to the given mod.
See CLIENT (type)
Deletes an existing team member from a mod.
See CLIENT (type)
Updates an existing team member in a mod.
See CLIENT (type)
Unsubscribe the current user from the given mod.
See CLIENT (type)
Returns the stats object for the given game.
See GAME-STATS (type)
See CLIENT (type)
Returns a list of tag options for the game.
See GAME-TAG-OPTION (type)
See CLIENT (type)
Adds a new tag option to a game.
See CLIENT (type)
Deletes an existing tag option from a game.
See CLIENT (type)
Returns the owner of the given object.
See USER (type)
See CLIENT (type)
Accesses the header IMAGE of the game.
See GAME (type)
See IMAGE (type)
Accesses whether the category should be hidden or not.
See GAME-TAG-OPTION (type)
Accesses the upstream homepage URL of the mod.
See MOD (type)
Accesses the icon IMAGE of the game.
See GAME (type)
See IMAGE (type)
Accesses the ID identifying the object on the API.
See UNIQUE-RESOURCE (type)
user-event)) ¶automatically generated reader method
id.
team-member)) ¶automatically generated reader method
id.
modfile)) ¶automatically generated reader method
id.
mod-event)) ¶automatically generated reader method
id.
comment)) ¶automatically generated reader method
id.
unique-resource)) ¶automatically generated reader method
id.
integer)) ¶unique-resource)) ¶automatically generated writer method
id.
Accesses the list of IMAGE objects for the mod.
See MOD-MEDIA (type)
Accesses the text to display for instructions on user contributions.
See GAME (type)
Accesses the URL to display for further user instructions.
See GAME (type)
Accesses the member’s invite status.
Can be one of:
:ACCEPTED
:PENDING
See TEAM-MEMBER (type)
team-member)) ¶automatically generated reader method
Accesses the karma (vote status) of the comment.
See COMMENT (type)
Accesses the language that is passed to the API.
This defaults to English. You should set it to the user’s preferred language
to ensure you get messages from the API in that language.
See CLIENT (type)
Accesses the timestamp at which the user was last seen online.
See USER (type)
Accesses the level of the member.
Can be a list composed of:
:MODERATOR
:MANAGER
:ADMINISTRATOR
See TEAM-MEMBER (type)
team-member)) ¶automatically generated reader method
Returns a list of mods in the local modlist.
See SIMPLE-CLIENT (type)
simple-client)) ¶Returns a list of mods the user is subscribed to.
See SIMPLE-CLIENT (type)
simple-client)) ¶Accesses whether the category should be locked or not.
See GAME-TAG-OPTION (type)
game-tag-option)) ¶automatically generated reader method
Accesses the logo IMAGE of the object.
See GAME (type)
See MOD (type)
See IMAGE (type)
Accesses the maturity options of the game.
Can be a list composed of:
:ALLOWED
See GAME (type)
Returns the current user that is authenticated.
See CLIENT (type)
See USER (type)
Returns a list of user events.
See CLIENT (type)
See USER-EVENT (type)
Returns a list of files the current user has contributed to.
See CLIENT (type)
See MODFILE (type)
Returns a list of games the current user has contributed to.
See CLIENT (type)
See GAME (type)
Returns a list of mods the current user has contributed to.
See CLIENT (type)
See MOD (type)
Returns a list of ratings the current user has contributed.
See CLIENT (type)
See RATING (type)
Returns a list of subscribed mods for the current user.
See CLIENT (type)
See MOD (type)
Accesses the media object of the mod.
See MOD (type)
See MOD-MEDIA (type)
Returns the message that was supplied about the failure.
See REQUEST-ERROR
request-error)) ¶Accesses the metadata table of the mod.
See MOD (type)
Accesses the metadata blob of the object.
See MOD (type)
See MODFILE (type)
Returns the MOD object this object is associated with.
See MOD (type)
See MOD-RESOURCE (type)
mod-resource)) ¶Returns the directory in which the given mod’s files are stored.
See SIMPLE-CLIENT (type)
simple-client) mod) ¶Accesses the ID of the MOD this object is associated with.
See MOD-RESOURCE (type)
user-event)) ¶automatically generated reader method
modfile)) ¶automatically generated reader method
mod-stats)) ¶automatically generated reader method
mod-event)) ¶automatically generated reader method
mod-dependency)) ¶automatically generated reader method
comment)) ¶automatically generated reader method
mod-resource)) ¶automatically generated reader method
mod-resource)) ¶automatically generated writer method
Accesses the most recent modfile of the mod.
See MOD (type)
See MODFILE (type)
modfile-error)) ¶Returns the directory in which modfiles are cached.
See SIMPLE-CLIENT (type)
simple-client)) ¶Returns the file in which the list of mods is stored.
See SIMPLE-CLIENT (type)
simple-client)) ¶Accesses the total number of mods available for the game.
See GAME-STATS (type)
game-stats)) ¶automatically generated reader method
mods.
Accesses the path to the directory in which the client will manage mod data.
See SIMPLE-CLIENT (type)
simple-client)) ¶automatically generated reader method
simple-client)) ¶automatically generated writer method
Accesses the name of the object.
Note that this name is not necessarily unique.
see NAMED-RESOURCE (type)
See NAME-ID
mod-tag)) ¶automatically generated reader method
name.
mod-dependency)) ¶automatically generated reader method
name.
game-tag-option)) ¶automatically generated reader method
name.
named-resource)) ¶automatically generated reader method
name.
named-resource)) ¶automatically generated writer method
name.
Accesses the name-id of the object.
Unlike the NAME this is unique.
See NAMED-RESOURCE (type)
See NAME
named-resource)) ¶automatically generated reader method
named-resource)) ¶automatically generated writer method
Accesses the default action to perform when rate limitation is hit.
Can be one of:
:RETURN — The REQUEST simply returns NIL
:SLEEP — The thread is put to sleep until the deadline
:ERROR — An error of TOO-MANY-REQUESTS is signalled
function-designator — The function is called
See REQUEST
See WAIT-UNTIL
See TOO-MANY-REQUESTS (type)
See CLIENT (type)
Accesses the URL of the original image version.
See IMAGE (type)
Accesses the platform that is passed to the API.
Defaults to DETECT-PLATFORM.
See DETECT-PLATFORM
See CLIENT (type)
Accesses the popularity metrics plist.
Contains the following keys:
:POSITION
:TOTAL
See MOD-STATS (type)
Accesses the portal that is passed to the API.
Defaults to DETECT-PORTAL
See DETECT-PORTAL
See CLIENT (type)
Accesses the presentation option of the game.
Can be one of:
:GRID
:TABLE
See GAME (type)
Accesses the URL at which the object can be accessed canonically.
See GAME (type)
See MOD (type)
See USER (type)
Accesses the rating of the object.
For the RATING this can be one of:
:GOOD
:NONE
:BAD
For the MOD-STATS this is a plist containing the following keys:
:TOTAL
:POSITIVE
:NEGATIVE
:PERCENTAGE
:AGGREGATE
:TEXT
See MOD-STATS (type)
See RATING (type)
Returns the COMMENT object that this is a reply to, if any.
See COMMENT (type)
Accesses the ID of the comment this is a reply to.
See COMMENT (type)
Submit a report about something that violates terms of service or rules.
See CLIENT (type)
Perform an API request from the client.
Handles rate limitation and appending all necessary headers and parameters
from the client for a proper API request. Otherwise same in function as
DIRECT-REQUEST
See ON-RATE-LIMIT
See DIRECT-REQUEST
See CLIENT (type)
Perform a listified request.
This calls REQUEST, but automatically re-calling REQUEST to traverse the
entire list of contents on the remote API endpoint. The following extra
arguments are available:
:COLLECT-RESULTS — If non-NIL, the results are accumulated and returned.
:KEY — Function called for each object in the listed endpoint.
:START — Start offset into the listed endpoint. Defaults to 0.
:END — End limit of the listed endpoint. Defaults to infinity.
:PER-PAGE — How many results to deliver per request. Defaults to 100.
:SORT — By which attribute to sort the request. Can also be a
list of attribute and :ASC or :DESC to change direction.
:FILTER — May be a list of filtering expressions to limit the results.
Use the F macro to construct a filter.
See F
See CLIENT (type)
Restores the client’s settings from the given form.
The form should be one that is EQUAL to one returned by EXTRACT-USER-PROPERTIES.
See EXTRACT-USER-PROPERTIES
See CLIENT (type)
Accesses the revenue options of the game.
Can be a list composed of:
:SELLING-ALLOWED
:DONATIONS-ALLOWED
:TRADING-ALLOWED
:SCARCITY-CONTROL-ALLOWED
See GAME (type)
Accesses the list of Sketchfab video URLs for the mod.
See MOD-MEDIA (type)
Accesses the statistical data of the object.
See GAME (type)
See MOD (type)
Accesses the status of the object.
Can be one of:
:UNACCEPTED
:ACCEPTED
:DELETED
See GAME (type)
See MOD (type)
Accesses the submission option of the game.
Can be one of:
:API
:ANYWHERE
See GAME (type)
Accesses the USER object that submitted this object.
See USER (type)
See GAME (type)
See MOD (type)
Accesses the total number of subscribers of the object.
See GAME-STATS (type)
See MOD-STATS (type)
mod-stats)) ¶automatically generated reader method
game-stats)) ¶automatically generated reader method
Accesses the short summary text of the object.
See GAME (type)
See MOD (type)
Synchronise the modlist with the remote.
This assumes the remote has the correct data. Deviations in the local
modlist are subject to the following:
IF-DOES-NOT-EXIST may be one of the following:
:CREATE — The mod is downloaded and extracted.
:ERROR — An error is signalled.
NIL — Nothing is done.
IF-EXISTS may be one of the following:
:DELETE — The mod’s files are deleted.
:DEACTIVATE — The mod is marked as inactive.
:ERROR — An error is signalled.
NIL — Nothing is done.
After completing the sync, the local modlist is written.
See SIMPLE-CLIENT (type)
simple-client) &key if-does-not-exist if-exists) ¶Synchronise the modlist with the remote.
This assumes the local modlist has the correct data.
All subscriptions are updated to reflect the current modlist.
See SIMPLE-CLIENT (type)
simple-client) &key) ¶Accesses the number of tags in the category.
See GAME-TAG-OPTION (type)
game-tag-option)) ¶automatically generated reader method
Accesses the tag options of the game
See GAME (type)
See GAME-TAG-OPTION (type)
Accesses the type of tag category this is.
Can be one of:
:CHECKBOXES
:DROPDOWN
See GAME-TAG-OPTION (type)
game-tag-option)) ¶automatically generated reader method
Accesses the list of actual tags of the object.
See GAME-TAG-OPTION (type)
See MOD (type)
Returns the target path of the modfile operation.
See MODFILE-ERROR (type)
modfile-error)) ¶Accesses the position of the comment in the thread.
See COMMENT (type)
Accesses the list of thumbnails for the image.
Returns a PLIST where the keys are resolution widths and the values
are URLs to images. May include the following keys:
50 64 100 128 256 320 640 1280
See IMAGE (type)
Accesses the member’s official title.
See TEAM-MEMBER (type)
team-member)) ¶automatically generated reader method
Accesses the UGC type name of the game.
See GAME (type)
Update all local mods if possible.
IF-EXISTS may be one of the following:
:SUPERSEDE — The files are only updated if the remote is newer.
:OVERWRITE — The files are updated unconditionally.
If-DOES-NOT-EXIST may be one of the following:
:DELETE — The local files are deleted.
:DEACTIVATE — The mod is marked as inactive.
:ERROR — An error is signalled.
NIL — Nothing is done.
After completing the sync, the local modlist is written.
See SIMPLE-CLIENT (type)
simple-client) &key if-exists if-does-not-exist) ¶Returns the USER object associated with the object.
See USER (type)
See COMMENT (type)
See TEAM-MEMBER (type)
team-member)) ¶automatically generated reader method
user.
Accesses the ID of the USER this object is associated with.
See USER-RESOURCE (type)
user-event)) ¶automatically generated reader method
mod-event)) ¶automatically generated reader method
user-resource)) ¶automatically generated reader method
user-resource)) ¶automatically generated writer method
Returns true if the given object is still considered valid.
See DATE-EXPIRES
game-stats)) ¶Accesses the deadline until which the access-key is valid.
See ACCESS-KEY
See CLIENT (type)
Accesses the version string of the mod payload.
See MODFILE (type)
Accesses the hash that the virus scanner produced.
See MODFILE (type)
Accesses the virus scan’s result.
Can be one of:
:NO-THREATS
:FLAGGED
See MODFILE (type)
Accesses the virus scan’s status.
Can be one of:
:UNSCANNED
:COMPLETED
:IN-PROGRESS
:TOO-LARGE
:FILE-NOT-FOUND
:SCANNING-ERROR
See MODFILE (type)
Accesses the visibility of the mod.
Can be one of:
:HIDDEN
:PUBLIC
See MOD (type)
Accesses the deadline until which requests are deferred.
Can be NIL or a universal-time timestamp.
See REQUEST
See CLIENT (type)
Writes the list of mods into the local modlist file.
See SIMPLE-CLIENT (type)
simple-client) modlist) ¶Accesses the list of YouTube video URLs for the mod.
See MOD-MEDIA (type)
unique-resource) stream) ¶named-resource) stream) ¶Error signalled when interacting from a banned account.
See PERMISSION-DENIED
Error signalled when interacting from a deleted account.
See PERMISSION-DENIED
Error signalled on a malformed request.
See REQUEST-ERROR
Error signalled when interacting with a comment that doesn’t exist.
See RESOURCE-NOT-FOUND
Error signalled when the downloaded modfile does not match expected size and hash.
See FILE-SIZE
See MODFILE-ERROR (type)
Error signalled when interacting with a game that doesn’t exist.
See RESOURCE-NOT-FOUND
Error signalled when the used access key is invalid.
See REQUEST-ERROR
Error signalled when interacting with a mod that has been deleted.
See RESOURCE-NOT-FOUND
Error signalled when interacting with a mod that doesn’t exist.
See RESOURCE-NOT-FOUND
Base condition for all errors related to modfile management.
See MODIO-CONDITION (type)
See MODFILE
See TARGET
error.
modio-condition.
Error signalled when interacting with a modfile that doesn’t exist.
See RESOURCE-NOT-FOUND
Base condition class for everything from this library.
condition.
Error signalled when attempting to access an endpoint without proper authorisation.
See REQUEST-ERROR
Base error class for any request failure.
See MODIO-CONDITION
See DATA
See ENDPOINT
See ARGUMENTS
See ERROR-CODE
See MESSAGE
error.
modio-condition.
(quote (error "endpoint required."))
:endpoint
This slot is read-only.
(quote nil)
:arguments
This slot is read-only.
(quote nil)
:error-code
This slot is read-only.
Error signalled when attempting to submit an object with the same ID as one that already exists.
See REQUEST-ERROR
Error signalled when interacting with an object that doesn’t exist.
See REQUEST-ERROR
Error signalled when the remote server encountered an unexpected issue.
See REQUEST-ERROR
Error signalled when the remote service is temporarily unavailable.
See REQUEST-ERROR
Error signalled when the modfile is already cached.
See CLIENT (type)
Error signalled when the modfile is not properly cached.
See CLIENT (type)
Error signalled when too many requests have been made in a short time.
See REQUEST-ERROR
Error signalled when interacting with a user that doesn’t exist.
See RESOURCE-NOT-FOUND
Representation of a mod.io API client.
You should instantiate this with the correct API-KEY.
See *CLIENT*
See API-KEY
See ACCESS-TOKEN
See LANGUAGE
See PLATFORM
See PORTAL
See WAIT-UNTIL
See VALID-UNTIL
See ON-RATE-LIMIT
See CACHE
See DEFAULT-GAME-ID
See REQUEST
See REQUEST-LIST
See EXTRACT-USER-PROPERTIES
See RESTORE-USER-PROPERTIES
(setf access-token).
access-token.
(setf api-key).
api-key.
authenticate/discord.
authenticate/email-exchange.
authenticate/email-request.
authenticate/epic.
authenticate/gog-galaxy.
authenticate/google.
authenticate/itchio.
authenticate/logout.
authenticate/oculus.
authenticate/openid.
authenticate/steam.
authenticate/switch.
authenticate/terms.
authenticate/xbox.
authenticated-p.
(setf cache).
cache.
cache-listing.
cache-object.
clear-cache.
complete-authentication.
(setf default-game-id).
default-game-id.
extract-user-properties.
games.
games/edit.
games/get.
games/get.
games/media/add.
games/mods.
games/mods/add.
games/mods/comments.
games/mods/comments/add.
games/mods/comments/delete.
games/mods/comments/edit.
games/mods/comments/get.
games/mods/comments/get.
games/mods/delete.
games/mods/dependencies.
games/mods/dependencies/add.
games/mods/dependencies/delete.
games/mods/edit.
games/mods/events.
games/mods/files.
games/mods/files/add.
games/mods/files/delete.
games/mods/files/edit.
games/mods/files/get.
games/mods/files/get.
games/mods/get.
games/mods/get.
games/mods/media/add.
games/mods/media/delete.
games/mods/metadata.
games/mods/metadata/add.
games/mods/metadata/delete.
games/mods/mod-events.
games/mods/ratings/add.
games/mods/stats.
games/mods/stats/all.
games/mods/subscribe.
games/mods/tags.
games/mods/tags/add.
games/mods/tags/delete.
games/mods/team.
games/mods/team/add.
games/mods/team/delete.
games/mods/team/edit.
games/mods/unsubscribe.
games/stats.
games/tags.
games/tags/add.
games/tags/delete.
general/ownership.
get-listing.
(setf language).
language.
make-load-form.
me.
me/events.
me/files.
me/games.
me/mods.
me/ratings.
me/subscribed.
(setf on-rate-limit).
on-rate-limit.
(setf platform).
platform.
(setf portal).
portal.
print-object.
report.
request.
request-list.
restore-user-properties.
(setf valid-until).
valid-until.
(setf wait-until).
wait-until.
:api-key
:access-token
"english"
:language
(org.shirakumo.fraf.modio:detect-platform)
:platform
(org.shirakumo.fraf.modio:detect-portal)
:portal
:wait-until
:valid-until
:sleep
:on-rate-limit
(org.shirakumo.fraf.modio::make-cache)
0
:default-game-id
Represents a comment on a mod.
See UNIQUE-RESOURCE (type)
See MOD-RESOURCE (type)
See USER
See DATE-ADDED
See REPLY-ID
See THREAD-POSITION
See KARMA
See CONTENT
See REPLY
Representation of a download.
See BINARY-URL
See DATE-EXPIRES
Represents a game on the moddb registry.
See NAMED-RESOURCE (type)
See UNIQUE-RESOURCE (type)
:submitted-by
This slot is read-only.
:date-added
This slot is read-only.
:date-updated
This slot is read-only.
:presentation
This slot is read-only.
:submission
This slot is read-only.
:api-access
This slot is read-only.
:instructions
This slot is read-only.
:instructions-url
This slot is read-only.
:profile-url
This slot is read-only.
:tag-options
This slot is read-only.
Base class for any object that is a child of a game.
See GAME-ID
Represents statistics about a game.
See GAME-RESOURCE (type)
See MODS
See DOWNLOADS
See SUBSCRIBERS
See DATE-EXPIRES
Represents a tagging option for the game.
See NAMED-RESOURCE (type)
See TAG-TYPE
See TAGS
See TAG-COUNT
See HIDDEN
See LOCKED
Representation of an image object.
See FILENAME
See ORIGINAL
See THUMBNAILS
:thumbnails
This slot is read-only.
Representation of a game mod.
See NAMED-RESOURCE (type)
See UNIQUE-RESOURCE (type)
See GAME-RESOURCE (type)
See STATUS
See VISIBLE
See SUBMITTED-BY
See DATE-ADDED
See DATE-UPDATED
See DATE-LIVE
See MATURITY
See LOGO
See HOMEPAGE-URL
See SUMMARY
See DESCRIPTION
See DESCRIPTION-HTML
See MODFILE
See METADATA-BLOB
See PROFILE-URL
See MEDIA
See STATS
See METADATA
See TAGS
:submitted-by
This slot is read-only.
:date-added
This slot is read-only.
:date-updated
This slot is read-only.
:homepage-url
This slot is read-only.
:description
This slot is read-only.
:description-html
This slot is read-only.
:metadata-blob
This slot is read-only.
:profile-url
This slot is read-only.
Represents a dependency of a mod on another.
See NAMED-RESOURCE (type)
See MOD-RESOURCE (type)
See DATE-ADDED
:date-added
This slot is read-only.
Represents a change event on a mod.
See UNIQUE-RESOURCE (type)
See MOD-RESOURCE (type)
See USER-RESOURCE (type)
See DATE-ADDED
See EVENT-TYPE
Representation of media associated with a mod.
See YOUTUBE-URLS
See SKETCHFAB-URLS
See IMAGES
Base class for any object that is a child of a mod.
See MOD-ID
See MOD
Representation of the statistics about a mod.
See MOD-RESOURCE (type)
See DATE-EXPIRES
See POPULARITY
See DOWNLOADS
See SUBSCRIBERS
See RATING
:date-expires
This slot is read-only.
:popularity
This slot is read-only.
:subscribers
This slot is read-only.
Representation of a tag on a mod.
See NAMED-RESOURCE (type)
See DATE-ADDED
:date-added
This slot is read-only.
Representation of a mod’s payload.
See UNIQUE-RESOURCE (type)
See MOD-RESOURCE (type)
See DATE-ADDED
See DATE-SCANNED
See VIRUS-STATUS
See VIRUS-POSITIVE
See VIRUS-HASH
See FILE-SIZE
See FILE-HASH
See FILE-NAME
See VERSION
See CHANGELOG
See METADATA-BLOB
See DOWNLOAD
:date-added
This slot is read-only.
:date-scanned
This slot is read-only.
:virus-status
This slot is read-only.
:virus-positive
This slot is read-only.
:virus-hash
This slot is read-only.
:metadata-blob
This slot is read-only.
Base class for any object that has a name and possibly name ID.
See NAME
See NAME-ID
Representation of a rating on a game or mod.
See MOD-RESOURCE (type)
See GAME-RESOURCE (type)
See RATING
See DATE-ADDED
:date-added
This slot is read-only.
Client that implements a simplified interface for mod management.
You must supply a DEFAULT-GAME-ID and MODS-DIRECTORY.
See CLIENT (type)
See MODS-DIRECTORY
See MODLIST-FILE
See MODFILE-CACHE-DIRECTORY
See MOD-DIRECTORY
See LOAD-LOCAL-MODLIST
See WRITE-LOCAL-MODLIST
See LOAD-REMOTE-MODLIST
See DOWNLOAD-MODFILE
See EXTRACT-MODFILE
See FIND-MODFILE
See SYNC-MODLIST-FROM-REMOTE
See SYNC-MODLIST-TO-REMOTE
See UPDATE-LOCAL-MODS
See DETERMINE-MOD-PROPERTIES
Representation of a team member.
See UNIQUE-RESOURCE (type)
See USER
See LEVEL
See DATE-ADDED
See TITLE
See INVITE
:date-added
This slot is read-only.
Base class for any object that has a unique ID.
See ID
comment.
game.
mod.
mod-event.
modfile.
team-member.
user.
user-event.
Represents a user.
See NAMED-RESOURCE (type)
See UNIQUE-RESOURCE (type)
See DISPLAY-NAME
See LAST-ONLINE
See AVATAR
See PROFILE-URL
:display-name
This slot is read-only.
:last-online
This slot is read-only.
:profile-url
This slot is read-only.
Represents a change event on a user.
See UNIQUE-RESOURCE (type)
See MOD-RESOURCE (type)
See GAME-RESOURCE (type)
See USER-RESOURCE (type)
See DATE-ADDED
See EVENT-TYPE
Base class for any object that is a child of a user.
See USER-ID
user-event) (data hash-table)) ¶team-member) (data hash-table)) ¶mod-dependency) (data hash-table)) ¶(eql org.shirakumo.fraf.modio:message)) data) ¶game-tag-option) (data hash-table)) ¶game-stats) (data hash-table)) ¶symbol) (data null)) ¶symbol) (data vector)) ¶symbol) (data cons)) ¶symbol) data) ¶| Jump to: | %
(
A B C D E F G H I K L M N O P R S T U V W Y |
|---|
| Jump to: | %
(
A B C D E F G H I K L M N O P R S T U V W Y |
|---|
| Jump to: | *
A B C D E F G H I K L M N O P R S T U V W Y |
|---|
| Jump to: | *
A B C D E F G H I K L M N O P R S T U V W Y |
|---|
| Jump to: | A B C D E F G I M N O P R S T U |
|---|
| Jump to: | A B C D E F G I M N O P R S T U |
|---|