openapi: 3.0.3
info:
title: dddice
description: ''
version: 1.0.0
servers:
-
url: 'https://dddice.com'
paths:
/api/1.0/theme:
get:
summary: 'List Themes'
operationId: listThemes
description: "Fetch a list of themes. Only the most recent version of each theme is returned\nwhere the \"most recent\" is determined by [SemVer 2.0.0](https://semver.org/spec/v2.0.0.html)"
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
type: 'theme[]'
data:
-
meshes:
d4: 'https://cdn.dddice.com/mesh/d04.fbx'
d6: 'https://cdn.dddice.com/mesh/d06.fbx'
d8: 'https://cdn.dddice.com/mesh/d08.fbx'
d10: 'https://cdn.dddice.com/mesh/d10.fbx'
d10x: 'https://cdn.dddice.com/mesh/d10.fbx'
d12: 'https://cdn.dddice.com/mesh/d12.fbx'
d20: 'https://cdn.dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://cdn.dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: odio-ex-quis
name: Miss
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Consequatur inventore perspiciatis ducimus suscipit assumenda. Doloribus doloribus voluptatibus fugit hic libero harum. Modi officia facilis aut impedit molestiae.'
user:
username: emmerich.taya
uuid: 334a6222-6054-11ee-8c15-000d3a9285ca
name: 'Edwin Weimann'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
-
meshes:
d4: 'https://cdn.dddice.com/mesh/d04.fbx'
d6: 'https://cdn.dddice.com/mesh/d06.fbx'
d8: 'https://cdn.dddice.com/mesh/d08.fbx'
d10: 'https://cdn.dddice.com/mesh/d10.fbx'
d10x: 'https://cdn.dddice.com/mesh/d10.fbx'
d12: 'https://cdn.dddice.com/mesh/d12.fbx'
d20: 'https://cdn.dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://cdn.dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: quod-nihil
name: Prof.
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Quia sit atque nemo quo pariatur provident natus porro. Dolore incidunt ut doloremque. Deleniti vero quo recusandae ipsa odio assumenda. Excepturi et harum voluptas amet molestias velit cumque. Qui eaque beatae tempora repellat quam dolorem est ut.'
user:
username: janie23
uuid: 334bc5c9-6054-11ee-8c15-000d3a9285ca
name: 'Antonina Predovic IV'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
properties:
type:
type: string
example: 'theme[]'
data:
type: array
example:
-
meshes:
d4: 'https://cdn.dddice.com/mesh/d04.fbx'
d6: 'https://cdn.dddice.com/mesh/d06.fbx'
d8: 'https://cdn.dddice.com/mesh/d08.fbx'
d10: 'https://cdn.dddice.com/mesh/d10.fbx'
d10x: 'https://cdn.dddice.com/mesh/d10.fbx'
d12: 'https://cdn.dddice.com/mesh/d12.fbx'
d20: 'https://cdn.dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://cdn.dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: odio-ex-quis
name: Miss
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Consequatur inventore perspiciatis ducimus suscipit assumenda. Doloribus doloribus voluptatibus fugit hic libero harum. Modi officia facilis aut impedit molestiae.'
user:
username: emmerich.taya
uuid: 334a6222-6054-11ee-8c15-000d3a9285ca
name: 'Edwin Weimann'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
-
meshes:
d4: 'https://cdn.dddice.com/mesh/d04.fbx'
d6: 'https://cdn.dddice.com/mesh/d06.fbx'
d8: 'https://cdn.dddice.com/mesh/d08.fbx'
d10: 'https://cdn.dddice.com/mesh/d10.fbx'
d10x: 'https://cdn.dddice.com/mesh/d10.fbx'
d12: 'https://cdn.dddice.com/mesh/d12.fbx'
d20: 'https://cdn.dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://cdn.dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: quod-nihil
name: Prof.
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Quia sit atque nemo quo pariatur provident natus porro. Dolore incidunt ut doloremque. Deleniti vero quo recusandae ipsa odio assumenda. Excepturi et harum voluptas amet molestias velit cumque. Qui eaque beatae tempora repellat quam dolorem est ut.'
user:
username: janie23
uuid: 334bc5c9-6054-11ee-8c15-000d3a9285ca
name: 'Antonina Predovic IV'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
items:
type: object
properties:
meshes:
type: object
properties:
d4:
type: string
example: 'https://cdn.dddice.com/mesh/d04.fbx'
d6:
type: string
example: 'https://cdn.dddice.com/mesh/d06.fbx'
d8:
type: string
example: 'https://cdn.dddice.com/mesh/d08.fbx'
d10:
type: string
example: 'https://cdn.dddice.com/mesh/d10.fbx'
d10x:
type: string
example: 'https://cdn.dddice.com/mesh/d10.fbx'
d12:
type: string
example: 'https://cdn.dddice.com/mesh/d12.fbx'
d20:
type: string
example: 'https://cdn.dddice.com/mesh/d20.fbx'
available_dice:
type: array
example:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
items:
type: string
physics:
type: object
properties:
inertia:
type: object
properties:
d4:
type: integer
example: 5
d6:
type: integer
example: 12
d8:
type: integer
example: 10
d10:
type: integer
example: 9
d10x:
type: integer
example: 9
d12:
type: integer
example: 8
d20:
type: integer
example: 6
weight:
type: object
properties:
d4:
type: integer
example: 300
d6:
type: integer
example: 300
d8:
type: integer
example: 340
d10:
type: integer
example: 350
d10x:
type: integer
example: 350
d12:
type: integer
example: 350
d20:
type: integer
example: 400
sizes:
type: object
properties:
d4:
type: integer
example: 1
d6:
type: integer
example: 1
d8:
type: integer
example: 1
d10:
type: integer
example: 1
d10x:
type: integer
example: 1
d12:
type: integer
example: 1
d20:
type: integer
example: 1
sounds:
type: array
example:
-
src: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://cdn.dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
items:
type: object
properties:
src:
type: string
example: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on':
type: string
example: die.collide
uniforms:
type: object
properties:
number:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.424
r:
type: number
example: 0.463
diffuse:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.929
r:
type: integer
example: 1
values:
type: object
properties:
d4:
type: array
example:
- 1
- 2
- 3
- 4
items:
type: integer
d6:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
items:
type: integer
d8:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
items:
type: integer
d10:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
items:
type: integer
d12:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
items:
type: integer
d20:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
items:
type: integer
d10x:
type: array
example:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
items:
type: integer
id:
type: string
example: odio-ex-quis
name:
type: string
example: Miss
label:
type: object
properties:
color:
type: string
example: '#000000'
background_color:
type: string
example: '#e3d12d'
version:
type: string
example: 1.0.0
textures:
type: array
example:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
items:
type: object
properties:
src:
type: object
properties:
d4:
type: string
example: u_numberMap.png
d6:
type: string
example: u_numberMap.png
d8:
type: string
example: u_numberMap.png
d10:
type: string
example: u_numberMap.png
d12:
type: string
example: u_numberMap.png
d20:
type: string
example: u_numberMap.png
d10x:
type: string
example: u_numberMap_d10x.png
binding:
type: string
example: u_numberMap
api_version:
type: string
example: '1.0'
description:
type: string
example: 'Consequatur inventore perspiciatis ducimus suscipit assumenda. Doloribus doloribus voluptatibus fugit hic libero harum. Modi officia facilis aut impedit molestiae.'
user:
type: object
properties:
username:
type: string
example: emmerich.taya
uuid:
type: string
example: 334a6222-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Edwin Weimann'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
tags:
- Theme
post:
summary: 'Create a Theme'
operationId: createATheme
description: 'Create a theme using a theme manifest and save to your dddice.'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
data:
meshes:
d4: 'https://cdn.dddice.com/mesh/d04.fbx'
d6: 'https://cdn.dddice.com/mesh/d06.fbx'
d8: 'https://cdn.dddice.com/mesh/d08.fbx'
d10: 'https://cdn.dddice.com/mesh/d10.fbx'
d10x: 'https://cdn.dddice.com/mesh/d10.fbx'
d12: 'https://cdn.dddice.com/mesh/d12.fbx'
d20: 'https://cdn.dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://cdn.dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: qui-modi
name: Dr.
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Non sint nulla velit sunt impedit sit. Sit consequuntur natus quod facere iste repellat. Error minus et atque quas blanditiis.'
user:
username: tianna.borer
uuid: 33530ba6-6054-11ee-8c15-000d3a9285ca
name: 'Emmy Crooks II'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
properties:
data:
type: object
properties:
meshes:
type: object
properties:
d4:
type: string
example: 'https://cdn.dddice.com/mesh/d04.fbx'
d6:
type: string
example: 'https://cdn.dddice.com/mesh/d06.fbx'
d8:
type: string
example: 'https://cdn.dddice.com/mesh/d08.fbx'
d10:
type: string
example: 'https://cdn.dddice.com/mesh/d10.fbx'
d10x:
type: string
example: 'https://cdn.dddice.com/mesh/d10.fbx'
d12:
type: string
example: 'https://cdn.dddice.com/mesh/d12.fbx'
d20:
type: string
example: 'https://cdn.dddice.com/mesh/d20.fbx'
available_dice:
type: array
example:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
items:
type: string
physics:
type: object
properties:
inertia:
type: object
properties:
d4:
type: integer
example: 5
d6:
type: integer
example: 12
d8:
type: integer
example: 10
d10:
type: integer
example: 9
d10x:
type: integer
example: 9
d12:
type: integer
example: 8
d20:
type: integer
example: 6
weight:
type: object
properties:
d4:
type: integer
example: 300
d6:
type: integer
example: 300
d8:
type: integer
example: 340
d10:
type: integer
example: 350
d10x:
type: integer
example: 350
d12:
type: integer
example: 350
d20:
type: integer
example: 400
sizes:
type: object
properties:
d4:
type: integer
example: 1
d6:
type: integer
example: 1
d8:
type: integer
example: 1
d10:
type: integer
example: 1
d10x:
type: integer
example: 1
d12:
type: integer
example: 1
d20:
type: integer
example: 1
sounds:
type: array
example:
-
src: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://cdn.dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
items:
type: object
properties:
src:
type: string
example: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on':
type: string
example: die.collide
uniforms:
type: object
properties:
number:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.424
r:
type: number
example: 0.463
diffuse:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.929
r:
type: integer
example: 1
values:
type: object
properties:
d4:
type: array
example:
- 1
- 2
- 3
- 4
items:
type: integer
d6:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
items:
type: integer
d8:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
items:
type: integer
d10:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
items:
type: integer
d12:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
items:
type: integer
d20:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
items:
type: integer
d10x:
type: array
example:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
items:
type: integer
id:
type: string
example: qui-modi
name:
type: string
example: Dr.
label:
type: object
properties:
color:
type: string
example: '#000000'
background_color:
type: string
example: '#e3d12d'
version:
type: string
example: 1.0.0
textures:
type: array
example:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
items:
type: object
properties:
src:
type: object
properties:
d4:
type: string
example: u_numberMap.png
d6:
type: string
example: u_numberMap.png
d8:
type: string
example: u_numberMap.png
d10:
type: string
example: u_numberMap.png
d12:
type: string
example: u_numberMap.png
d20:
type: string
example: u_numberMap.png
d10x:
type: string
example: u_numberMap_d10x.png
binding:
type: string
example: u_numberMap
api_version:
type: string
example: '1.0'
description:
type: string
example: 'Non sint nulla velit sunt impedit sit. Sit consequuntur natus quod facere iste repellat. Error minus et atque quas blanditiis.'
user:
type: object
properties:
username:
type: string
example: tianna.borer
uuid:
type: string
example: 33530ba6-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Emmy Crooks II'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
tags:
- Theme
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
frag_shader:
type: string
description: 'Custom fragment shader'
example: optio
manifest:
type: string
description: 'Theme manifest configuration'
example: '{"meshes":{"d4":"/mesh/d04.fbx","d6":"/mesh/d06.fbx","d8":"/mesh/d08.fbx","d10":"/mesh/d10.fbx","d10x":"/mesh/d10.fbx","d12":"/mesh/d12.fbx","d20":"/mesh/d20.fbx"},"available_dice":["d4","d6","d8","d10","d10x","d12","d20"],"physics":{"inertia":{"d4":5,"d6":12,"d8":10,"d10":9,"d10x":9,"d12":8,"d20":6},"weight":{"d4":300,"d6":300,"d8":340,"d10":350,"d10x":350,"d12":350,"d20":400}},"sizes":{"d4":1,"d6":1,"d8":1,"d10":1,"d10x":1,"d12":1,"d20":1},"sounds":[{"src":"/sounds/roll-1.mp3","on":"die.collide"},{"src":"/sounds/roll-2.mp3","on":"die.collide"},{"src":"/sounds/roll-3.mp3","on":"die.collide"}],"uniforms":{"diffuse":{"type":"color","value":{"r":1,"g":0.929,"b":0}},"number":{"type":"color","value":{"r":0.463,"g":0.424,"b":0}}},"values":{"d4":[1,2,3,4],"d6":[1,2,3,4,5,6],"d8":[1,2,3,4,5,6,7,8],"d10":[1,2,3,4,5,6,7,8,9,10],"d12":[1,2,3,4,5,6,7,8,9,10,11,12],"d20":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20],"d10x":[10,20,30,40,50,60,70,80,90,0]},"id":"delectus_perferendis","version":"1.0.0","api_version":"1.0","name":"Miss","description":"Distinctio esse est dolores sit praesentium laboriosam officiis. Iure qui voluptatibus quidem atque nobis est consectetur enim. Eveniet harum quod quae optio repellat.","label":{"color":"#000000","background_color":"#e3d12d"},"textures":[{"binding":"u_numberMap","src":{"d4":"u_numberMap.png","d6":"u_numberMap.png","d8":"u_numberMap.png","d10":"u_numberMap.png","d12":"u_numberMap.png","d20":"u_numberMap.png","d10x":"u_numberMap_d10x.png"}}],"user":{"username":"ea_est","uuid":"c5de15e0-4337-11ed-abda-0242ac120003","name":"Ms. Demetris Mraz II","created_at":"2022-10-03T16:23:55.000000Z","updated_at":"2022-10-03T16:23:55.000000Z"},"created_at":"2022-10-03T16:23:55.000000Z","updated_at":"2022-10-03T16:23:55.000000Z"}'
vert_shader:
type: string
description: 'Custom vertex shader'
example: fugiat
assets:
type: array
description: 'Associated theme assets, filenames must match manifest.json references'
example:
- null
items:
type: File
required:
- manifest
'/api/1.0/theme/{id}':
get:
summary: 'Get Theme'
operationId: getTheme
description: 'Get information about a theme. Returns the latest version.'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
meshes:
d4: 'https://cdn.dddice.com/mesh/d04.fbx'
d6: 'https://cdn.dddice.com/mesh/d06.fbx'
d8: 'https://cdn.dddice.com/mesh/d08.fbx'
d10: 'https://cdn.dddice.com/mesh/d10.fbx'
d10x: 'https://cdn.dddice.com/mesh/d10.fbx'
d12: 'https://cdn.dddice.com/mesh/d12.fbx'
d20: 'https://cdn.dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://cdn.dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: quidem-et-quo
name: Dr.
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Iusto ut doloribus est in culpa laborum voluptate officia. Quia quia minus sed similique placeat perspiciatis. Nostrum itaque veritatis voluptate aut. Deserunt repudiandae autem magnam corporis consequatur inventore. Et aut neque a est modi.'
user:
username: alisa24
uuid: 33561b63-6054-11ee-8c15-000d3a9285ca
name: 'Magnolia Schinner'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
properties:
data:
type: object
properties:
meshes:
type: object
properties:
d4:
type: string
example: 'https://cdn.dddice.com/mesh/d04.fbx'
d6:
type: string
example: 'https://cdn.dddice.com/mesh/d06.fbx'
d8:
type: string
example: 'https://cdn.dddice.com/mesh/d08.fbx'
d10:
type: string
example: 'https://cdn.dddice.com/mesh/d10.fbx'
d10x:
type: string
example: 'https://cdn.dddice.com/mesh/d10.fbx'
d12:
type: string
example: 'https://cdn.dddice.com/mesh/d12.fbx'
d20:
type: string
example: 'https://cdn.dddice.com/mesh/d20.fbx'
available_dice:
type: array
example:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
items:
type: string
physics:
type: object
properties:
inertia:
type: object
properties:
d4:
type: integer
example: 5
d6:
type: integer
example: 12
d8:
type: integer
example: 10
d10:
type: integer
example: 9
d10x:
type: integer
example: 9
d12:
type: integer
example: 8
d20:
type: integer
example: 6
weight:
type: object
properties:
d4:
type: integer
example: 300
d6:
type: integer
example: 300
d8:
type: integer
example: 340
d10:
type: integer
example: 350
d10x:
type: integer
example: 350
d12:
type: integer
example: 350
d20:
type: integer
example: 400
sizes:
type: object
properties:
d4:
type: integer
example: 1
d6:
type: integer
example: 1
d8:
type: integer
example: 1
d10:
type: integer
example: 1
d10x:
type: integer
example: 1
d12:
type: integer
example: 1
d20:
type: integer
example: 1
sounds:
type: array
example:
-
src: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://cdn.dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
items:
type: object
properties:
src:
type: string
example: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on':
type: string
example: die.collide
uniforms:
type: object
properties:
number:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.424
r:
type: number
example: 0.463
diffuse:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.929
r:
type: integer
example: 1
values:
type: object
properties:
d4:
type: array
example:
- 1
- 2
- 3
- 4
items:
type: integer
d6:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
items:
type: integer
d8:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
items:
type: integer
d10:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
items:
type: integer
d12:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
items:
type: integer
d20:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
items:
type: integer
d10x:
type: array
example:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
items:
type: integer
id:
type: string
example: quidem-et-quo
name:
type: string
example: Dr.
label:
type: object
properties:
color:
type: string
example: '#000000'
background_color:
type: string
example: '#e3d12d'
version:
type: string
example: 1.0.0
textures:
type: array
example:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
items:
type: object
properties:
src:
type: object
properties:
d4:
type: string
example: u_numberMap.png
d6:
type: string
example: u_numberMap.png
d8:
type: string
example: u_numberMap.png
d10:
type: string
example: u_numberMap.png
d12:
type: string
example: u_numberMap.png
d20:
type: string
example: u_numberMap.png
d10x:
type: string
example: u_numberMap_d10x.png
binding:
type: string
example: u_numberMap
api_version:
type: string
example: '1.0'
description:
type: string
example: 'Iusto ut doloribus est in culpa laborum voluptate officia. Quia quia minus sed similique placeat perspiciatis. Nostrum itaque veritatis voluptate aut. Deserunt repudiandae autem magnam corporis consequatur inventore. Et aut neque a est modi.'
user:
type: object
properties:
username:
type: string
example: alisa24
uuid:
type: string
example: 33561b63-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Magnolia Schinner'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
tags:
- Theme
delete:
summary: 'Delete Theme'
operationId: deleteTheme
description: 'Delete all versions of a given theme.'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
204:
description: ''
tags:
- Theme
parameters:
-
in: path
name: id
description: 'The ID of the theme.'
example: dddice-standard
required: true
schema:
type: string
'/api/1.0/theme/{id}/version':
get:
summary: 'Get All Theme Versions'
operationId: getAllThemeVersions
description: 'List all versions of a given theme.'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
type: 'theme[]'
data:
-
meshes:
d4: 'https://cdn.dddice.com/mesh/d04.fbx'
d6: 'https://cdn.dddice.com/mesh/d06.fbx'
d8: 'https://cdn.dddice.com/mesh/d08.fbx'
d10: 'https://cdn.dddice.com/mesh/d10.fbx'
d10x: 'https://cdn.dddice.com/mesh/d10.fbx'
d12: 'https://cdn.dddice.com/mesh/d12.fbx'
d20: 'https://cdn.dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://cdn.dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: sunt-libero-libero
name: Prof.
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Deserunt in sit minima dolorem harum aut rem. Consequatur porro maiores perspiciatis iste. Qui repellendus eos placeat ratione itaque porro quia.'
user:
username: lane.hermiston
uuid: 335a009b-6054-11ee-8c15-000d3a9285ca
name: 'Kristy Will'
created_at: '2023-10-01T12:15:25.000000Z'
updated_at: '2023-10-01T12:15:25.000000Z'
created_at: '2023-10-01T12:15:25.000000Z'
updated_at: '2023-10-01T12:15:25.000000Z'
-
meshes:
d4: 'https://cdn.dddice.com/mesh/d04.fbx'
d6: 'https://cdn.dddice.com/mesh/d06.fbx'
d8: 'https://cdn.dddice.com/mesh/d08.fbx'
d10: 'https://cdn.dddice.com/mesh/d10.fbx'
d10x: 'https://cdn.dddice.com/mesh/d10.fbx'
d12: 'https://cdn.dddice.com/mesh/d12.fbx'
d20: 'https://cdn.dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://cdn.dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: eius-officiis
name: Miss
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Consequatur voluptatem sit quo qui veritatis. Culpa et veritatis rerum iste. Ut similique cum eum debitis.'
user:
username: beau25
uuid: 335b6674-6054-11ee-8c15-000d3a9285ca
name: 'Karlee Cremin'
created_at: '2023-10-01T12:15:25.000000Z'
updated_at: '2023-10-01T12:15:25.000000Z'
created_at: '2023-10-01T12:15:25.000000Z'
updated_at: '2023-10-01T12:15:25.000000Z'
properties:
type:
type: string
example: 'theme[]'
data:
type: array
example:
-
meshes:
d4: 'https://cdn.dddice.com/mesh/d04.fbx'
d6: 'https://cdn.dddice.com/mesh/d06.fbx'
d8: 'https://cdn.dddice.com/mesh/d08.fbx'
d10: 'https://cdn.dddice.com/mesh/d10.fbx'
d10x: 'https://cdn.dddice.com/mesh/d10.fbx'
d12: 'https://cdn.dddice.com/mesh/d12.fbx'
d20: 'https://cdn.dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://cdn.dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: sunt-libero-libero
name: Prof.
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Deserunt in sit minima dolorem harum aut rem. Consequatur porro maiores perspiciatis iste. Qui repellendus eos placeat ratione itaque porro quia.'
user:
username: lane.hermiston
uuid: 335a009b-6054-11ee-8c15-000d3a9285ca
name: 'Kristy Will'
created_at: '2023-10-01T12:15:25.000000Z'
updated_at: '2023-10-01T12:15:25.000000Z'
created_at: '2023-10-01T12:15:25.000000Z'
updated_at: '2023-10-01T12:15:25.000000Z'
-
meshes:
d4: 'https://cdn.dddice.com/mesh/d04.fbx'
d6: 'https://cdn.dddice.com/mesh/d06.fbx'
d8: 'https://cdn.dddice.com/mesh/d08.fbx'
d10: 'https://cdn.dddice.com/mesh/d10.fbx'
d10x: 'https://cdn.dddice.com/mesh/d10.fbx'
d12: 'https://cdn.dddice.com/mesh/d12.fbx'
d20: 'https://cdn.dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://cdn.dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: eius-officiis
name: Miss
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Consequatur voluptatem sit quo qui veritatis. Culpa et veritatis rerum iste. Ut similique cum eum debitis.'
user:
username: beau25
uuid: 335b6674-6054-11ee-8c15-000d3a9285ca
name: 'Karlee Cremin'
created_at: '2023-10-01T12:15:25.000000Z'
updated_at: '2023-10-01T12:15:25.000000Z'
created_at: '2023-10-01T12:15:25.000000Z'
updated_at: '2023-10-01T12:15:25.000000Z'
items:
type: object
properties:
meshes:
type: object
properties:
d4:
type: string
example: 'https://cdn.dddice.com/mesh/d04.fbx'
d6:
type: string
example: 'https://cdn.dddice.com/mesh/d06.fbx'
d8:
type: string
example: 'https://cdn.dddice.com/mesh/d08.fbx'
d10:
type: string
example: 'https://cdn.dddice.com/mesh/d10.fbx'
d10x:
type: string
example: 'https://cdn.dddice.com/mesh/d10.fbx'
d12:
type: string
example: 'https://cdn.dddice.com/mesh/d12.fbx'
d20:
type: string
example: 'https://cdn.dddice.com/mesh/d20.fbx'
available_dice:
type: array
example:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
items:
type: string
physics:
type: object
properties:
inertia:
type: object
properties:
d4:
type: integer
example: 5
d6:
type: integer
example: 12
d8:
type: integer
example: 10
d10:
type: integer
example: 9
d10x:
type: integer
example: 9
d12:
type: integer
example: 8
d20:
type: integer
example: 6
weight:
type: object
properties:
d4:
type: integer
example: 300
d6:
type: integer
example: 300
d8:
type: integer
example: 340
d10:
type: integer
example: 350
d10x:
type: integer
example: 350
d12:
type: integer
example: 350
d20:
type: integer
example: 400
sizes:
type: object
properties:
d4:
type: integer
example: 1
d6:
type: integer
example: 1
d8:
type: integer
example: 1
d10:
type: integer
example: 1
d10x:
type: integer
example: 1
d12:
type: integer
example: 1
d20:
type: integer
example: 1
sounds:
type: array
example:
-
src: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://cdn.dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
items:
type: object
properties:
src:
type: string
example: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on':
type: string
example: die.collide
uniforms:
type: object
properties:
number:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.424
r:
type: number
example: 0.463
diffuse:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.929
r:
type: integer
example: 1
values:
type: object
properties:
d4:
type: array
example:
- 1
- 2
- 3
- 4
items:
type: integer
d6:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
items:
type: integer
d8:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
items:
type: integer
d10:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
items:
type: integer
d12:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
items:
type: integer
d20:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
items:
type: integer
d10x:
type: array
example:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
items:
type: integer
id:
type: string
example: sunt-libero-libero
name:
type: string
example: Prof.
label:
type: object
properties:
color:
type: string
example: '#000000'
background_color:
type: string
example: '#e3d12d'
version:
type: string
example: 1.0.0
textures:
type: array
example:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
items:
type: object
properties:
src:
type: object
properties:
d4:
type: string
example: u_numberMap.png
d6:
type: string
example: u_numberMap.png
d8:
type: string
example: u_numberMap.png
d10:
type: string
example: u_numberMap.png
d12:
type: string
example: u_numberMap.png
d20:
type: string
example: u_numberMap.png
d10x:
type: string
example: u_numberMap_d10x.png
binding:
type: string
example: u_numberMap
api_version:
type: string
example: '1.0'
description:
type: string
example: 'Deserunt in sit minima dolorem harum aut rem. Consequatur porro maiores perspiciatis iste. Qui repellendus eos placeat ratione itaque porro quia.'
user:
type: object
properties:
username:
type: string
example: lane.hermiston
uuid:
type: string
example: 335a009b-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Kristy Will'
created_at:
type: string
example: '2023-10-01T12:15:25.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:25.000000Z'
created_at:
type: string
example: '2023-10-01T12:15:25.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:25.000000Z'
tags:
- Theme
parameters:
-
in: path
name: id
description: 'The ID of the theme.'
example: dddice-standard
required: true
schema:
type: string
'/api/1.0/theme/{id}/version/{version}':
get:
summary: 'Get a Theme Version'
operationId: getAThemeVersion
description: 'Get a specific version of a given theme.'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
data:
meshes:
d4: 'https://cdn.dddice.com/mesh/d04.fbx'
d6: 'https://cdn.dddice.com/mesh/d06.fbx'
d8: 'https://cdn.dddice.com/mesh/d08.fbx'
d10: 'https://cdn.dddice.com/mesh/d10.fbx'
d10x: 'https://cdn.dddice.com/mesh/d10.fbx'
d12: 'https://cdn.dddice.com/mesh/d12.fbx'
d20: 'https://cdn.dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://cdn.dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: minima-non-iure
name: Prof.
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Non fugiat nesciunt quidem qui et ducimus est. Amet voluptas dolorem beatae temporibus voluptatem voluptas voluptatem. Id ipsa itaque ea debitis non maxime blanditiis occaecati. Excepturi omnis minus qui aut quaerat nihil fugit.'
user:
username: melyna05
uuid: 335ed64a-6054-11ee-8c15-000d3a9285ca
name: 'Mr. Griffin Lang Sr.'
created_at: '2023-10-01T12:15:25.000000Z'
updated_at: '2023-10-01T12:15:25.000000Z'
created_at: '2023-10-01T12:15:25.000000Z'
updated_at: '2023-10-01T12:15:25.000000Z'
properties:
data:
type: object
properties:
meshes:
type: object
properties:
d4:
type: string
example: 'https://cdn.dddice.com/mesh/d04.fbx'
d6:
type: string
example: 'https://cdn.dddice.com/mesh/d06.fbx'
d8:
type: string
example: 'https://cdn.dddice.com/mesh/d08.fbx'
d10:
type: string
example: 'https://cdn.dddice.com/mesh/d10.fbx'
d10x:
type: string
example: 'https://cdn.dddice.com/mesh/d10.fbx'
d12:
type: string
example: 'https://cdn.dddice.com/mesh/d12.fbx'
d20:
type: string
example: 'https://cdn.dddice.com/mesh/d20.fbx'
available_dice:
type: array
example:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
items:
type: string
physics:
type: object
properties:
inertia:
type: object
properties:
d4:
type: integer
example: 5
d6:
type: integer
example: 12
d8:
type: integer
example: 10
d10:
type: integer
example: 9
d10x:
type: integer
example: 9
d12:
type: integer
example: 8
d20:
type: integer
example: 6
weight:
type: object
properties:
d4:
type: integer
example: 300
d6:
type: integer
example: 300
d8:
type: integer
example: 340
d10:
type: integer
example: 350
d10x:
type: integer
example: 350
d12:
type: integer
example: 350
d20:
type: integer
example: 400
sizes:
type: object
properties:
d4:
type: integer
example: 1
d6:
type: integer
example: 1
d8:
type: integer
example: 1
d10:
type: integer
example: 1
d10x:
type: integer
example: 1
d12:
type: integer
example: 1
d20:
type: integer
example: 1
sounds:
type: array
example:
-
src: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://cdn.dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
items:
type: object
properties:
src:
type: string
example: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on':
type: string
example: die.collide
uniforms:
type: object
properties:
number:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.424
r:
type: number
example: 0.463
diffuse:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.929
r:
type: integer
example: 1
values:
type: object
properties:
d4:
type: array
example:
- 1
- 2
- 3
- 4
items:
type: integer
d6:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
items:
type: integer
d8:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
items:
type: integer
d10:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
items:
type: integer
d12:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
items:
type: integer
d20:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
items:
type: integer
d10x:
type: array
example:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
items:
type: integer
id:
type: string
example: minima-non-iure
name:
type: string
example: Prof.
label:
type: object
properties:
color:
type: string
example: '#000000'
background_color:
type: string
example: '#e3d12d'
version:
type: string
example: 1.0.0
textures:
type: array
example:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
items:
type: object
properties:
src:
type: object
properties:
d4:
type: string
example: u_numberMap.png
d6:
type: string
example: u_numberMap.png
d8:
type: string
example: u_numberMap.png
d10:
type: string
example: u_numberMap.png
d12:
type: string
example: u_numberMap.png
d20:
type: string
example: u_numberMap.png
d10x:
type: string
example: u_numberMap_d10x.png
binding:
type: string
example: u_numberMap
api_version:
type: string
example: '1.0'
description:
type: string
example: 'Non fugiat nesciunt quidem qui et ducimus est. Amet voluptas dolorem beatae temporibus voluptatem voluptas voluptatem. Id ipsa itaque ea debitis non maxime blanditiis occaecati. Excepturi omnis minus qui aut quaerat nihil fugit.'
user:
type: object
properties:
username:
type: string
example: melyna05
uuid:
type: string
example: 335ed64a-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Mr. Griffin Lang Sr.'
created_at:
type: string
example: '2023-10-01T12:15:25.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:25.000000Z'
created_at:
type: string
example: '2023-10-01T12:15:25.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:25.000000Z'
tags:
- Theme
delete:
summary: 'Delete Theme Version'
operationId: deleteThemeVersion
description: 'Delete a specific version of a given theme.'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
204:
description: ''
tags:
- Theme
parameters:
-
in: path
name: id
description: 'The ID of the theme.'
example: dddice-standard
required: true
schema:
type: string
-
in: path
name: version
description: 'Theme Version.'
example: 1.0.0
required: true
schema:
type: string
'/api/1.0/theme/{id}/report':
post:
summary: 'Report Theme'
operationId: reportTheme
description: 'Report a theme for abuse or spam.'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
204:
description: ''
tags:
- Theme
parameters:
-
in: path
name: id
description: 'The ID of the theme.'
example: dddice-standard
required: true
schema:
type: string
/api/1.0/room:
get:
summary: 'List Rooms'
operationId: listRooms
description: 'List all rooms created or joined by a user'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
type: 'room[]'
data:
-
name: 'Untitled Room'
is_public: true
bg_file_path: null
slug: oxESC0q
passcode: at
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: dee.little
uuid: 32d3ce04-6054-11ee-8c15-000d3a9285ca
name: 'Mrs. Yvonne Kub'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
participants:
-
id: 2
username: voluptatum_optio
color: '#d9f3d4'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: era69
uuid: 32d445de-6054-11ee-8c15-000d3a9285ca
name: 'Derick Watsica V'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
-
id: 3
username: beatae_et
color: '#e15f1b'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: gerhold.jaylan
uuid: 32d4cd1e-6054-11ee-8c15-000d3a9285ca
name: 'Prof. Madilyn Collier'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
-
name: 'Untitled Room'
is_public: true
bg_file_path: null
slug: Yqnjb9b
passcode: voluptatem
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: armstrong.clara
uuid: 32d6d9d9-6054-11ee-8c15-000d3a9285ca
name: 'Hillard Gerlach'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
participants:
-
id: 4
username: quod_qui
color: '#5a985a'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: titus.lesch
uuid: 32d7326a-6054-11ee-8c15-000d3a9285ca
name: 'Vance Walter'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
-
id: 5
username: id_cupiditate
color: '#1eef10'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: metz.marcelino
uuid: 32d79857-6054-11ee-8c15-000d3a9285ca
name: 'Imelda Schumm'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
properties:
type:
type: string
example: 'room[]'
data:
type: array
example:
-
name: 'Untitled Room'
is_public: true
bg_file_path: null
slug: oxESC0q
passcode: at
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: dee.little
uuid: 32d3ce04-6054-11ee-8c15-000d3a9285ca
name: 'Mrs. Yvonne Kub'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
participants:
-
id: 2
username: voluptatum_optio
color: '#d9f3d4'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: era69
uuid: 32d445de-6054-11ee-8c15-000d3a9285ca
name: 'Derick Watsica V'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
-
id: 3
username: beatae_et
color: '#e15f1b'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: gerhold.jaylan
uuid: 32d4cd1e-6054-11ee-8c15-000d3a9285ca
name: 'Prof. Madilyn Collier'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
-
name: 'Untitled Room'
is_public: true
bg_file_path: null
slug: Yqnjb9b
passcode: voluptatem
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: armstrong.clara
uuid: 32d6d9d9-6054-11ee-8c15-000d3a9285ca
name: 'Hillard Gerlach'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
participants:
-
id: 4
username: quod_qui
color: '#5a985a'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: titus.lesch
uuid: 32d7326a-6054-11ee-8c15-000d3a9285ca
name: 'Vance Walter'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
-
id: 5
username: id_cupiditate
color: '#1eef10'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: metz.marcelino
uuid: 32d79857-6054-11ee-8c15-000d3a9285ca
name: 'Imelda Schumm'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
items:
type: object
properties:
name:
type: string
example: 'Untitled Room'
is_public:
type: boolean
example: true
bg_file_path:
type: string
example: null
slug:
type: string
example: oxESC0q
passcode:
type: string
example: at
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
user:
type: object
properties:
username:
type: string
example: dee.little
uuid:
type: string
example: 32d3ce04-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Mrs. Yvonne Kub'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
participants:
type: array
example:
-
id: 2
username: voluptatum_optio
color: '#d9f3d4'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: era69
uuid: 32d445de-6054-11ee-8c15-000d3a9285ca
name: 'Derick Watsica V'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
-
id: 3
username: beatae_et
color: '#e15f1b'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: gerhold.jaylan
uuid: 32d4cd1e-6054-11ee-8c15-000d3a9285ca
name: 'Prof. Madilyn Collier'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
items:
type: object
properties:
id:
type: integer
example: 2
username:
type: string
example: voluptatum_optio
color:
type: string
example: '#d9f3d4'
position:
type: integer
example: 0
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
deleted_at:
type: string
example: null
user:
type: object
properties:
username:
type: string
example: era69
uuid:
type: string
example: 32d445de-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Derick Watsica V'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
tags:
- Room
post:
summary: 'Create a Room'
operationId: createARoom
description: "Create a room and use the slug to perform actions in that room.\n\nIf `is_public` is set to `false`, the returned `passcode` will be required\nfor future requests to perform actions in this room.\n\nYou may optionally pass a valid `passcode` to generate your own code."
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
data:
name: 'Untitled Room'
is_public: true
bg_file_path: null
slug: A4Rj5QR
passcode: vel
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: ulangworth
uuid: 32dca992-6054-11ee-8c15-000d3a9285ca
name: 'Veronica Hintz'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
participants: []
properties:
data:
type: object
properties:
name:
type: string
example: 'Untitled Room'
is_public:
type: boolean
example: true
bg_file_path:
type: string
example: null
slug:
type: string
example: A4Rj5QR
passcode:
type: string
example: vel
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
user:
type: object
properties:
username:
type: string
example: ulangworth
uuid:
type: string
example: 32dca992-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Veronica Hintz'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
participants:
type: array
example: []
tags:
- Room
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
is_public:
type: boolean
description: 'Public or private'
example: false
name:
type: string
description: Name
example: et
passcode:
type: string
description: 'Passcode required for private rooms'
example: autem
'/api/1.0/room/{slug}':
get:
summary: 'Get a Room'
operationId: getARoom
description: 'Get information about a room and active participants.'
parameters:
-
in: query
name: passcode
description: 'Passcode required for private room'
example: ut
required: false
schema:
type: string
description: 'Passcode required for private room'
example: ut
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
name: 'Untitled Room'
is_public: true
bg_file_path: null
slug: UELaLdu
passcode: temporibus
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: qwisoky
uuid: 32dfca82-6054-11ee-8c15-000d3a9285ca
name: 'Naomie Feeney'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
participants: []
properties:
data:
type: object
properties:
name:
type: string
example: 'Untitled Room'
is_public:
type: boolean
example: true
bg_file_path:
type: string
example: null
slug:
type: string
example: UELaLdu
passcode:
type: string
example: temporibus
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
user:
type: object
properties:
username:
type: string
example: qwisoky
uuid:
type: string
example: 32dfca82-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Naomie Feeney'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
participants:
type: array
example: []
tags:
- Room
patch:
summary: 'Update a Room'
operationId: updateARoom
description: 'Update the name of a room'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
name: 'Untitled Room'
is_public: true
bg_file_path: null
slug: bBrwOG5
passcode: necessitatibus
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: alverta35
uuid: 32e485d8-6054-11ee-8c15-000d3a9285ca
name: 'Jayda Harris'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
participants: []
properties:
data:
type: object
properties:
name:
type: string
example: 'Untitled Room'
is_public:
type: boolean
example: true
bg_file_path:
type: string
example: null
slug:
type: string
example: bBrwOG5
passcode:
type: string
example: necessitatibus
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
user:
type: object
properties:
username:
type: string
example: alverta35
uuid:
type: string
example: 32e485d8-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Jayda Harris'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
participants:
type: array
example: []
tags:
- Room
requestBody:
required: false
content:
multipart/form-data:
schema:
type: object
properties:
is_public:
type: boolean
description: 'Public or private'
example: true
name:
type: string
description: Name
example: omnis
passcode:
type: boolean
description: 'Passcode required for private rooms'
example: false
background:
type: string
format: binary
description: 'Must be a file.'
custom_slug:
type: string
description: 'Must not be greater than 32 characters.'
example: euleimulhauj
settings:
type: string
description: ''
example: null
delete:
summary: 'Delete a Room'
operationId: deleteARoom
description: 'Delete a room you own.'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
204:
description: ''
tags:
- Room
parameters:
-
in: path
name: slug
description: 'The slug of the room.'
example: esse
required: true
schema:
type: string
'/api/1.0/room/{slug}/roll':
patch:
summary: 'Update Room Rolls'
operationId: updateRoomRolls
description: 'Automatically pickup dice from the board or unhide dice to players for all rolls in a room and for the current player.'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
type: 'roll[]'
data:
-
direction: 180
velocity: 1
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: pouros.cade
uuid: 32e9d129-6054-11ee-8c15-000d3a9285ca
name: 'Prof. Imogene Renner I'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
room:
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: soluta
slug: ub_ZMN6
custom_slug: null
settings:
chat:
backgroundColor: 0
deleteAfter: 30
fadeAfter: 10
isDiceExpanded: false
isDiceSorted: false
isUsernameVisible: true
isVisible: true
textColor: 16777215
textSize: sm
lighting:
ambientColor: 16777215
ambientIntensity: 0.5
spotlightColor: 16777215
spotlightIntensity: 0.33
participant:
defaultDiceTrayToGM: false
physics:
gravity: 9.82
throwSpeed: 30
roll:
allowPlayerRollUpdates: false
allowPlayerMoveDice: false
autoClear: 10
defaultClickBehavior: reroll
diceSize: 1
diceLimit: 25
diceTrayColor: 0
disableDiceOutline: false
disableDiceShadows: false
disableShakingSound: false
pickUp: 1
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
participants:
-
id: 9
username: pariatur_voluptas
color: '#43b5da'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: shields.jess
uuid: 32eae2a4-6054-11ee-8c15-000d3a9285ca
name: 'Colin Hills'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
values:
-
uuid: 32ec1dc2-6054-11ee-8c15-000d3a9285ca
is_hidden: true
is_user_value: true
is_visible: false
is_cleared: false
is_dropped: false
value: 2
value_to_display: '2'
type: d8
label: null
meta: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
total_value: 2
equation: 1d8
external_id: null
participants: []
-
direction: 180
velocity: 1
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: kathleen.gottlieb
uuid: 32edc198-6054-11ee-8c15-000d3a9285ca
name: 'Aliyah Gaylord'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
room:
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: voluptatem
slug: Pt5Fmdp
custom_slug: null
settings:
chat:
backgroundColor: 0
deleteAfter: 30
fadeAfter: 10
isDiceExpanded: false
isDiceSorted: false
isUsernameVisible: true
isVisible: true
textColor: 16777215
textSize: sm
lighting:
ambientColor: 16777215
ambientIntensity: 0.5
spotlightColor: 16777215
spotlightIntensity: 0.33
participant:
defaultDiceTrayToGM: false
physics:
gravity: 9.82
throwSpeed: 30
roll:
allowPlayerRollUpdates: false
allowPlayerMoveDice: false
autoClear: 10
defaultClickBehavior: reroll
diceSize: 1
diceLimit: 25
diceTrayColor: 0
disableDiceOutline: false
disableDiceShadows: false
disableShakingSound: false
pickUp: 1
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
participants:
-
id: 10
username: et_et
color: '#cdea1f'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: laury.walsh
uuid: 32eead45-6054-11ee-8c15-000d3a9285ca
name: 'Hildegard Kozey'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
values:
-
uuid: 32ef9e7e-6054-11ee-8c15-000d3a9285ca
is_hidden: true
is_user_value: false
is_visible: false
is_cleared: true
is_dropped: false
value: 3
value_to_display: '3'
type: d10
label: null
meta: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
total_value: 3
equation: 1d10
external_id: null
participants: []
properties:
type:
type: string
example: 'roll[]'
data:
type: array
example:
-
direction: 180
velocity: 1
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: pouros.cade
uuid: 32e9d129-6054-11ee-8c15-000d3a9285ca
name: 'Prof. Imogene Renner I'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
room:
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: soluta
slug: ub_ZMN6
custom_slug: null
settings:
chat:
backgroundColor: 0
deleteAfter: 30
fadeAfter: 10
isDiceExpanded: false
isDiceSorted: false
isUsernameVisible: true
isVisible: true
textColor: 16777215
textSize: sm
lighting:
ambientColor: 16777215
ambientIntensity: 0.5
spotlightColor: 16777215
spotlightIntensity: 0.33
participant:
defaultDiceTrayToGM: false
physics:
gravity: 9.82
throwSpeed: 30
roll:
allowPlayerRollUpdates: false
allowPlayerMoveDice: false
autoClear: 10
defaultClickBehavior: reroll
diceSize: 1
diceLimit: 25
diceTrayColor: 0
disableDiceOutline: false
disableDiceShadows: false
disableShakingSound: false
pickUp: 1
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
participants:
-
id: 9
username: pariatur_voluptas
color: '#43b5da'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: shields.jess
uuid: 32eae2a4-6054-11ee-8c15-000d3a9285ca
name: 'Colin Hills'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
values:
-
uuid: 32ec1dc2-6054-11ee-8c15-000d3a9285ca
is_hidden: true
is_user_value: true
is_visible: false
is_cleared: false
is_dropped: false
value: 2
value_to_display: '2'
type: d8
label: null
meta: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
total_value: 2
equation: 1d8
external_id: null
participants: []
-
direction: 180
velocity: 1
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: kathleen.gottlieb
uuid: 32edc198-6054-11ee-8c15-000d3a9285ca
name: 'Aliyah Gaylord'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
room:
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: voluptatem
slug: Pt5Fmdp
custom_slug: null
settings:
chat:
backgroundColor: 0
deleteAfter: 30
fadeAfter: 10
isDiceExpanded: false
isDiceSorted: false
isUsernameVisible: true
isVisible: true
textColor: 16777215
textSize: sm
lighting:
ambientColor: 16777215
ambientIntensity: 0.5
spotlightColor: 16777215
spotlightIntensity: 0.33
participant:
defaultDiceTrayToGM: false
physics:
gravity: 9.82
throwSpeed: 30
roll:
allowPlayerRollUpdates: false
allowPlayerMoveDice: false
autoClear: 10
defaultClickBehavior: reroll
diceSize: 1
diceLimit: 25
diceTrayColor: 0
disableDiceOutline: false
disableDiceShadows: false
disableShakingSound: false
pickUp: 1
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
participants:
-
id: 10
username: et_et
color: '#cdea1f'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: laury.walsh
uuid: 32eead45-6054-11ee-8c15-000d3a9285ca
name: 'Hildegard Kozey'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
values:
-
uuid: 32ef9e7e-6054-11ee-8c15-000d3a9285ca
is_hidden: true
is_user_value: false
is_visible: false
is_cleared: true
is_dropped: false
value: 3
value_to_display: '3'
type: d10
label: null
meta: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
total_value: 3
equation: 1d10
external_id: null
participants: []
items:
type: object
properties:
direction:
type: integer
example: 180
velocity:
type: integer
example: 1
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
user:
type: object
properties:
username:
type: string
example: pouros.cade
uuid:
type: string
example: 32e9d129-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Prof. Imogene Renner I'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
room:
type: object
properties:
is_public:
type: boolean
example: true
name:
type: string
example: 'Untitled Room'
bg_file_path:
type: string
example: null
passcode:
type: string
example: soluta
slug:
type: string
example: ub_ZMN6
custom_slug:
type: string
example: null
settings:
type: object
properties:
chat:
type: object
properties:
backgroundColor:
type: integer
example: 0
deleteAfter:
type: integer
example: 30
fadeAfter:
type: integer
example: 10
isDiceExpanded:
type: boolean
example: false
isDiceSorted:
type: boolean
example: false
isUsernameVisible:
type: boolean
example: true
isVisible:
type: boolean
example: true
textColor:
type: integer
example: 16777215
textSize:
type: string
example: sm
lighting:
type: object
properties:
ambientColor:
type: integer
example: 16777215
ambientIntensity:
type: number
example: 0.5
spotlightColor:
type: integer
example: 16777215
spotlightIntensity:
type: number
example: 0.33
participant:
type: object
properties:
defaultDiceTrayToGM:
type: boolean
example: false
physics:
type: object
properties:
gravity:
type: number
example: 9.82
throwSpeed:
type: integer
example: 30
roll:
type: object
properties:
allowPlayerRollUpdates:
type: boolean
example: false
allowPlayerMoveDice:
type: boolean
example: false
autoClear:
type: integer
example: 10
defaultClickBehavior:
type: string
example: reroll
diceSize:
type: integer
example: 1
diceLimit:
type: integer
example: 25
diceTrayColor:
type: integer
example: 0
disableDiceOutline:
type: boolean
example: false
disableDiceShadows:
type: boolean
example: false
disableShakingSound:
type: boolean
example: false
pickUp:
type: integer
example: 1
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
deleted_at:
type: string
example: null
participants:
type: array
example:
-
id: 9
username: pariatur_voluptas
color: '#43b5da'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: shields.jess
uuid: 32eae2a4-6054-11ee-8c15-000d3a9285ca
name: 'Colin Hills'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
items:
type: object
properties:
id:
type: integer
example: 9
username:
type: string
example: pariatur_voluptas
color:
type: string
example: '#43b5da'
position:
type: integer
example: 0
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
deleted_at:
type: string
example: null
user:
type: object
properties:
username: { type: string, example: shields.jess }
uuid: { type: string, example: 32eae2a4-6054-11ee-8c15-000d3a9285ca }
name: { type: string, example: 'Colin Hills' }
created_at: { type: string, example: '2023-10-01T12:15:24.000000Z' }
updated_at: { type: string, example: '2023-10-01T12:15:24.000000Z' }
values:
type: array
example:
-
uuid: 32ec1dc2-6054-11ee-8c15-000d3a9285ca
is_hidden: true
is_user_value: true
is_visible: false
is_cleared: false
is_dropped: false
value: 2
value_to_display: '2'
type: d8
label: null
meta: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
items:
type: object
properties:
uuid:
type: string
example: 32ec1dc2-6054-11ee-8c15-000d3a9285ca
is_hidden:
type: boolean
example: true
is_user_value:
type: boolean
example: true
is_visible:
type: boolean
example: false
is_cleared:
type: boolean
example: false
is_dropped:
type: boolean
example: false
value:
type: integer
example: 2
value_to_display:
type: string
example: '2'
type:
type: string
example: d8
label:
type: string
example: null
meta:
type: string
example: null
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
total_value:
type: integer
example: 2
equation:
type: string
example: 1d8
external_id:
type: string
example: null
participants:
type: array
example: []
tags:
- Room
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
dice:
type: object
description: 'Partial dice roll.'
example:
is_hidden: true
properties:
is_visible:
type: boolean
description: 'Roll value hidden'
example: false
is_cleared:
type: boolean
description: 'Roll value cleared'
example: false
required:
- dice
parameters:
-
in: path
name: slug
description: 'The slug of the room.'
example: 1
required: true
schema:
type: integer
'/api/1.0/room/{slug}/participant':
post:
summary: 'Join a Room'
operationId: joinARoom
description: 'Join a room as a participant'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
name: 'Untitled Room'
is_public: true
bg_file_path: null
slug: 3tU7hKw
passcode: ipsa
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: junius00
uuid: 32f437b5-6054-11ee-8c15-000d3a9285ca
name: 'Jakob Treutel III'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
participants: []
properties:
data:
type: object
properties:
name:
type: string
example: 'Untitled Room'
is_public:
type: boolean
example: true
bg_file_path:
type: string
example: null
slug:
type: string
example: 3tU7hKw
passcode:
type: string
example: ipsa
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
user:
type: object
properties:
username:
type: string
example: junius00
uuid:
type: string
example: 32f437b5-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Jakob Treutel III'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
participants:
type: array
example: []
tags:
- Room
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
passcode:
type: string
description: 'Passcode required for private room'
example: doloribus
parameters:
-
in: path
name: slug
description: 'The slug of the room.'
example: aliquam
required: true
schema:
type: string
'/api/1.0/room/{slug}/participant/{id}':
patch:
summary: 'Update a Participant'
operationId: updateAParticipant
description: 'Update the username or color of the room participant.'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
name: 'Untitled Room'
is_public: true
bg_file_path: null
slug: 6T3e-po
passcode: quod
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: friesen.elizabeth
uuid: 32f92851-6054-11ee-8c15-000d3a9285ca
name: 'Madalyn Roob'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
participants: []
properties:
data:
type: object
properties:
name:
type: string
example: 'Untitled Room'
is_public:
type: boolean
example: true
bg_file_path:
type: string
example: null
slug:
type: string
example: 6T3e-po
passcode:
type: string
example: quod
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
user:
type: object
properties:
username:
type: string
example: friesen.elizabeth
uuid:
type: string
example: 32f92851-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Madalyn Roob'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
participants:
type: array
example: []
tags:
- Room
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
passcode:
type: string
description: 'Passcode required for private room'
example: itaque
username:
type: string
description: "Update a participant's username"
example: consequatur
color:
type: string
description: "Update a participant's color."
example: '#FF0000'
delete:
summary: 'Leave a Room'
operationId: leaveARoom
description: "Remove a participant from a room. Participants can choose to leave a room\nusing this endpoint. Room owners have permission to remove any participant."
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
204:
description: ''
tags:
- Room
parameters:
-
in: path
name: slug
description: 'The slug of the room.'
example: ducimus
required: true
schema:
type: string
-
in: path
name: id
description: 'Participant ID'
example: harum
required: true
schema:
type: string
/api/1.0/roll:
post:
summary: 'Create a Roll'
operationId: createARoll
description: "Perform a dice roll and optionally send the result to a public or private room.\n\nDice roll values are calculated using the API but can optionally receive a\n`value` and/or `value_to_display` attribute to pass a predetermined value (i.e. when integrating with VTTs).\n\n**Operators**\nOperators allow one to manipulate the outcome of the dice roll. The syntax of operators is based on [Avrae](https://avrae.io/commands#roll) which\nimplements [d20 dice syntax](https://d20.readthedocs.io/en/latest/start.html#dice-syntax)."
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
data:
direction: 180
velocity: 1
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: cjones
uuid: 330609f6-6054-11ee-8c15-000d3a9285ca
name: 'Tomas Quigley II'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
room:
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: corporis
slug: AeQE_Ce
custom_slug: null
settings:
chat:
backgroundColor: 0
deleteAfter: 30
fadeAfter: 10
isDiceExpanded: false
isDiceSorted: false
isUsernameVisible: true
isVisible: true
textColor: 16777215
textSize: sm
lighting:
ambientColor: 16777215
ambientIntensity: 0.5
spotlightColor: 16777215
spotlightIntensity: 0.33
participant:
defaultDiceTrayToGM: false
physics:
gravity: 9.82
throwSpeed: 30
roll:
allowPlayerRollUpdates: false
allowPlayerMoveDice: false
autoClear: 10
defaultClickBehavior: reroll
diceSize: 1
diceLimit: 25
diceTrayColor: 0
disableDiceOutline: false
disableDiceShadows: false
disableShakingSound: false
pickUp: 1
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
participants:
-
id: 13
username: odit_quis
color: '#2d08a3'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: lori21
uuid: 33077b6f-6054-11ee-8c15-000d3a9285ca
name: 'Dr. Donny Mann IV'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
values:
-
uuid: 33085d19-6054-11ee-8c15-000d3a9285ca
is_hidden: true
is_user_value: false
is_visible: false
is_cleared: false
is_dropped: false
value: 3
value_to_display: '3'
type: d8
label: null
meta: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
total_value: 3
equation: 1d8
external_id: null
participants: []
properties:
data:
type: object
properties:
direction:
type: integer
example: 180
velocity:
type: integer
example: 1
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
user:
type: object
properties:
username:
type: string
example: cjones
uuid:
type: string
example: 330609f6-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Tomas Quigley II'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
room:
type: object
properties:
is_public:
type: boolean
example: true
name:
type: string
example: 'Untitled Room'
bg_file_path:
type: string
example: null
passcode:
type: string
example: corporis
slug:
type: string
example: AeQE_Ce
custom_slug:
type: string
example: null
settings:
type: object
properties:
chat:
type: object
properties:
backgroundColor:
type: integer
example: 0
deleteAfter:
type: integer
example: 30
fadeAfter:
type: integer
example: 10
isDiceExpanded:
type: boolean
example: false
isDiceSorted:
type: boolean
example: false
isUsernameVisible:
type: boolean
example: true
isVisible:
type: boolean
example: true
textColor:
type: integer
example: 16777215
textSize:
type: string
example: sm
lighting:
type: object
properties:
ambientColor:
type: integer
example: 16777215
ambientIntensity:
type: number
example: 0.5
spotlightColor:
type: integer
example: 16777215
spotlightIntensity:
type: number
example: 0.33
participant:
type: object
properties:
defaultDiceTrayToGM:
type: boolean
example: false
physics:
type: object
properties:
gravity:
type: number
example: 9.82
throwSpeed:
type: integer
example: 30
roll:
type: object
properties:
allowPlayerRollUpdates:
type: boolean
example: false
allowPlayerMoveDice:
type: boolean
example: false
autoClear:
type: integer
example: 10
defaultClickBehavior:
type: string
example: reroll
diceSize:
type: integer
example: 1
diceLimit:
type: integer
example: 25
diceTrayColor:
type: integer
example: 0
disableDiceOutline:
type: boolean
example: false
disableDiceShadows:
type: boolean
example: false
disableShakingSound:
type: boolean
example: false
pickUp:
type: integer
example: 1
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
deleted_at:
type: string
example: null
participants:
type: array
example:
-
id: 13
username: odit_quis
color: '#2d08a3'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: lori21
uuid: 33077b6f-6054-11ee-8c15-000d3a9285ca
name: 'Dr. Donny Mann IV'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
items:
type: object
properties:
id:
type: integer
example: 13
username:
type: string
example: odit_quis
color:
type: string
example: '#2d08a3'
position:
type: integer
example: 0
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
deleted_at:
type: string
example: null
user:
type: object
properties:
username:
type: string
example: lori21
uuid:
type: string
example: 33077b6f-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Dr. Donny Mann IV'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
values:
type: array
example:
-
uuid: 33085d19-6054-11ee-8c15-000d3a9285ca
is_hidden: true
is_user_value: false
is_visible: false
is_cleared: false
is_dropped: false
value: 3
value_to_display: '3'
type: d8
label: null
meta: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
items:
type: object
properties:
uuid:
type: string
example: 33085d19-6054-11ee-8c15-000d3a9285ca
is_hidden:
type: boolean
example: true
is_user_value:
type: boolean
example: false
is_visible:
type: boolean
example: false
is_cleared:
type: boolean
example: false
is_dropped:
type: boolean
example: false
value:
type: integer
example: 3
value_to_display:
type: string
example: '3'
type:
type: string
example: d8
label:
type: string
example: null
meta:
type: string
example: null
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
total_value:
type: integer
example: 3
equation:
type: string
example: 1d8
external_id:
type: string
example: null
participants:
type: array
example: []
tags:
- Roll
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
dice:
type: array
description: 'List of dice rolls.'
example:
-
type: d20
theme: dddice-red
-
type: d20
theme: dddice-red
items:
type: object
properties:
is_hidden:
type: boolean
description: ''
example: false
type:
type: string
description: 'Type of dice. Standard types are d20, d12, d10, d10x, d8, d6, and d4. Some themes have custom types and should be looked up in the available_themes'
example: enim
theme:
type: string
description: 'Theme ID'
example: fugit
label:
type: string
description: 'A human-readable string to label this dice of the roll with some meaning (ex fire damage vs slashing damage)'
example: ea
value:
type: number
description: 'Dice value. If no value is provided, dddice will generate a value using our balanced random number generator.'
example: 2.2527
value_to_display:
type: string|object
description: 'This can be used to replace the numeric value. This is useful in cases where a d20 might contain letters instead of numbers or if a player is speaking in tongues or hieroglyphs.'
example: qui
meta:
type: object
description: 'Optional data that is not critical to the functionality of a die roll but could be useful to store for display or informational purposes.'
example: []
properties: []
required:
- type
- theme
external_id:
type: string
description: 'Must not be greater than 256 characters.'
example: hykthiskapzbugryoiurci
operator:
type: object
description: 'Optional operators to manipulate the final value of the dice'
example: []
properties:
k:
type: string
description: 'Keep all matched values.'
example: '"h2"'
p:
type: string
description: 'Drop all matched values (Not yet implemented)'
example: non
rr:
type: string
description: 'Reroll all matched values until none match (Not yet implemented)'
example: animi
ro:
type: string
description: 'Reroll all matched values once (Not yet implemented)'
example: autem
ra:
type: string
description: 'Reroll up to one matched value once, keeping the original roll (Not yet implemented)'
example: voluptatem
e:
type: string
description: 'Explode, rolls another die for each matched value (Not yet implemented)'
example: natus
mi:
type: number
description: 'Set a minimum value for each die (Not yet implemented)'
example: 5.1641717
ma:
type: number
description: 'Set a maximum value for each die (Not yet implemented)'
example: 64.035304
room:
type: string
description: 'Room slug.'
example: HvvOlTl
whisper:
type: array
description: 'Participant IDs to whisper this roll to. Only participants specified will see this roll.'
example:
- 603.014354
items:
type: number
label:
type: string
description: 'Optional label for this roll.'
example: '"Longbow damage with Hunter''s Mark"'
required:
- dice
get:
summary: 'List rolls'
operationId: listRolls
description: 'Fetch rolls from a given room'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
type: 'roll[]'
data:
-
direction: 180
velocity: 1
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: pedro.schimmel
uuid: 330b87e7-6054-11ee-8c15-000d3a9285ca
name: 'Tre Cruickshank'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
room:
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: excepturi
slug: 3XlTdBr
custom_slug: null
settings:
chat:
backgroundColor: 0
deleteAfter: 30
fadeAfter: 10
isDiceExpanded: false
isDiceSorted: false
isUsernameVisible: true
isVisible: true
textColor: 16777215
textSize: sm
lighting:
ambientColor: 16777215
ambientIntensity: 0.5
spotlightColor: 16777215
spotlightIntensity: 0.33
participant:
defaultDiceTrayToGM: false
physics:
gravity: 9.82
throwSpeed: 30
roll:
allowPlayerRollUpdates: false
allowPlayerMoveDice: false
autoClear: 10
defaultClickBehavior: reroll
diceSize: 1
diceLimit: 25
diceTrayColor: 0
disableDiceOutline: false
disableDiceShadows: false
disableShakingSound: false
pickUp: 1
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
participants:
-
id: 14
username: quaerat_facere
color: '#5d3174'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: chaya70
uuid: 330c9bdb-6054-11ee-8c15-000d3a9285ca
name: 'Mr. Stephon Morar'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
values:
-
uuid: 330da839-6054-11ee-8c15-000d3a9285ca
is_hidden: false
is_user_value: true
is_visible: false
is_cleared: false
is_dropped: false
value: 2
value_to_display: '2'
type: d4
label: null
meta: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
total_value: 2
equation: 1d4
external_id: null
participants: []
-
direction: 180
velocity: 1
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: mayert.bernice
uuid: 330f3a5f-6054-11ee-8c15-000d3a9285ca
name: 'Catalina Klocko'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
room:
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: libero
slug: nSoAFEV
custom_slug: null
settings:
chat:
backgroundColor: 0
deleteAfter: 30
fadeAfter: 10
isDiceExpanded: false
isDiceSorted: false
isUsernameVisible: true
isVisible: true
textColor: 16777215
textSize: sm
lighting:
ambientColor: 16777215
ambientIntensity: 0.5
spotlightColor: 16777215
spotlightIntensity: 0.33
participant:
defaultDiceTrayToGM: false
physics:
gravity: 9.82
throwSpeed: 30
roll:
allowPlayerRollUpdates: false
allowPlayerMoveDice: false
autoClear: 10
defaultClickBehavior: reroll
diceSize: 1
diceLimit: 25
diceTrayColor: 0
disableDiceOutline: false
disableDiceShadows: false
disableShakingSound: false
pickUp: 1
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
participants:
-
id: 15
username: occaecati_voluptatem
color: '#1df72c'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: camron83
uuid: 33102bfc-6054-11ee-8c15-000d3a9285ca
name: 'Miss Lelia Herman Jr.'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
values:
-
uuid: 33110d1e-6054-11ee-8c15-000d3a9285ca
is_hidden: false
is_user_value: false
is_visible: true
is_cleared: false
is_dropped: false
value: 12
value_to_display: '12'
type: d12
label: null
meta: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
total_value: 12
equation: 1d12
external_id: null
participants: []
properties:
type:
type: string
example: 'roll[]'
data:
type: array
example:
-
direction: 180
velocity: 1
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: pedro.schimmel
uuid: 330b87e7-6054-11ee-8c15-000d3a9285ca
name: 'Tre Cruickshank'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
room:
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: excepturi
slug: 3XlTdBr
custom_slug: null
settings:
chat:
backgroundColor: 0
deleteAfter: 30
fadeAfter: 10
isDiceExpanded: false
isDiceSorted: false
isUsernameVisible: true
isVisible: true
textColor: 16777215
textSize: sm
lighting:
ambientColor: 16777215
ambientIntensity: 0.5
spotlightColor: 16777215
spotlightIntensity: 0.33
participant:
defaultDiceTrayToGM: false
physics:
gravity: 9.82
throwSpeed: 30
roll:
allowPlayerRollUpdates: false
allowPlayerMoveDice: false
autoClear: 10
defaultClickBehavior: reroll
diceSize: 1
diceLimit: 25
diceTrayColor: 0
disableDiceOutline: false
disableDiceShadows: false
disableShakingSound: false
pickUp: 1
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
participants:
-
id: 14
username: quaerat_facere
color: '#5d3174'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: chaya70
uuid: 330c9bdb-6054-11ee-8c15-000d3a9285ca
name: 'Mr. Stephon Morar'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
values:
-
uuid: 330da839-6054-11ee-8c15-000d3a9285ca
is_hidden: false
is_user_value: true
is_visible: false
is_cleared: false
is_dropped: false
value: 2
value_to_display: '2'
type: d4
label: null
meta: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
total_value: 2
equation: 1d4
external_id: null
participants: []
-
direction: 180
velocity: 1
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: mayert.bernice
uuid: 330f3a5f-6054-11ee-8c15-000d3a9285ca
name: 'Catalina Klocko'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
room:
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: libero
slug: nSoAFEV
custom_slug: null
settings:
chat:
backgroundColor: 0
deleteAfter: 30
fadeAfter: 10
isDiceExpanded: false
isDiceSorted: false
isUsernameVisible: true
isVisible: true
textColor: 16777215
textSize: sm
lighting:
ambientColor: 16777215
ambientIntensity: 0.5
spotlightColor: 16777215
spotlightIntensity: 0.33
participant:
defaultDiceTrayToGM: false
physics:
gravity: 9.82
throwSpeed: 30
roll:
allowPlayerRollUpdates: false
allowPlayerMoveDice: false
autoClear: 10
defaultClickBehavior: reroll
diceSize: 1
diceLimit: 25
diceTrayColor: 0
disableDiceOutline: false
disableDiceShadows: false
disableShakingSound: false
pickUp: 1
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
participants:
-
id: 15
username: occaecati_voluptatem
color: '#1df72c'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: camron83
uuid: 33102bfc-6054-11ee-8c15-000d3a9285ca
name: 'Miss Lelia Herman Jr.'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
values:
-
uuid: 33110d1e-6054-11ee-8c15-000d3a9285ca
is_hidden: false
is_user_value: false
is_visible: true
is_cleared: false
is_dropped: false
value: 12
value_to_display: '12'
type: d12
label: null
meta: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
total_value: 12
equation: 1d12
external_id: null
participants: []
items:
type: object
properties:
direction:
type: integer
example: 180
velocity:
type: integer
example: 1
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
user:
type: object
properties:
username:
type: string
example: pedro.schimmel
uuid:
type: string
example: 330b87e7-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Tre Cruickshank'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
room:
type: object
properties:
is_public:
type: boolean
example: true
name:
type: string
example: 'Untitled Room'
bg_file_path:
type: string
example: null
passcode:
type: string
example: excepturi
slug:
type: string
example: 3XlTdBr
custom_slug:
type: string
example: null
settings:
type: object
properties:
chat:
type: object
properties:
backgroundColor:
type: integer
example: 0
deleteAfter:
type: integer
example: 30
fadeAfter:
type: integer
example: 10
isDiceExpanded:
type: boolean
example: false
isDiceSorted:
type: boolean
example: false
isUsernameVisible:
type: boolean
example: true
isVisible:
type: boolean
example: true
textColor:
type: integer
example: 16777215
textSize:
type: string
example: sm
lighting:
type: object
properties:
ambientColor:
type: integer
example: 16777215
ambientIntensity:
type: number
example: 0.5
spotlightColor:
type: integer
example: 16777215
spotlightIntensity:
type: number
example: 0.33
participant:
type: object
properties:
defaultDiceTrayToGM:
type: boolean
example: false
physics:
type: object
properties:
gravity:
type: number
example: 9.82
throwSpeed:
type: integer
example: 30
roll:
type: object
properties:
allowPlayerRollUpdates:
type: boolean
example: false
allowPlayerMoveDice:
type: boolean
example: false
autoClear:
type: integer
example: 10
defaultClickBehavior:
type: string
example: reroll
diceSize:
type: integer
example: 1
diceLimit:
type: integer
example: 25
diceTrayColor:
type: integer
example: 0
disableDiceOutline:
type: boolean
example: false
disableDiceShadows:
type: boolean
example: false
disableShakingSound:
type: boolean
example: false
pickUp:
type: integer
example: 1
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
deleted_at:
type: string
example: null
participants:
type: array
example:
-
id: 14
username: quaerat_facere
color: '#5d3174'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: chaya70
uuid: 330c9bdb-6054-11ee-8c15-000d3a9285ca
name: 'Mr. Stephon Morar'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
items:
type: object
properties:
id:
type: integer
example: 14
username:
type: string
example: quaerat_facere
color:
type: string
example: '#5d3174'
position:
type: integer
example: 0
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
deleted_at:
type: string
example: null
user:
type: object
properties:
username: { type: string, example: chaya70 }
uuid: { type: string, example: 330c9bdb-6054-11ee-8c15-000d3a9285ca }
name: { type: string, example: 'Mr. Stephon Morar' }
created_at: { type: string, example: '2023-10-01T12:15:24.000000Z' }
updated_at: { type: string, example: '2023-10-01T12:15:24.000000Z' }
values:
type: array
example:
-
uuid: 330da839-6054-11ee-8c15-000d3a9285ca
is_hidden: false
is_user_value: true
is_visible: false
is_cleared: false
is_dropped: false
value: 2
value_to_display: '2'
type: d4
label: null
meta: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
items:
type: object
properties:
uuid:
type: string
example: 330da839-6054-11ee-8c15-000d3a9285ca
is_hidden:
type: boolean
example: false
is_user_value:
type: boolean
example: true
is_visible:
type: boolean
example: false
is_cleared:
type: boolean
example: false
is_dropped:
type: boolean
example: false
value:
type: integer
example: 2
value_to_display:
type: string
example: '2'
type:
type: string
example: d4
label:
type: string
example: null
meta:
type: string
example: null
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
total_value:
type: integer
example: 2
equation:
type: string
example: 1d4
external_id:
type: string
example: null
participants:
type: array
example: []
tags:
- Roll
patch:
summary: 'Bulk Update Rolls'
operationId: bulkUpdateRolls
description: "Pickup dice from the board or unhide dice to players for multiple rolls.\n\nAccepts an array of objects with the the same parameters as `PATCH /api/1.0/roll/{id}`."
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
type: 'roll[]'
data:
-
direction: 180
velocity: 1
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: madisyn22
uuid: 3321a2e7-6054-11ee-8c15-000d3a9285ca
name: 'Meta Ferry'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
room:
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: sed
slug: BNwkMUG
custom_slug: null
settings:
chat:
backgroundColor: 0
deleteAfter: 30
fadeAfter: 10
isDiceExpanded: false
isDiceSorted: false
isUsernameVisible: true
isVisible: true
textColor: 16777215
textSize: sm
lighting:
ambientColor: 16777215
ambientIntensity: 0.5
spotlightColor: 16777215
spotlightIntensity: 0.33
participant:
defaultDiceTrayToGM: false
physics:
gravity: 9.82
throwSpeed: 30
roll:
allowPlayerRollUpdates: false
allowPlayerMoveDice: false
autoClear: 10
defaultClickBehavior: reroll
diceSize: 1
diceLimit: 25
diceTrayColor: 0
disableDiceOutline: false
disableDiceShadows: false
disableShakingSound: false
pickUp: 1
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
participants:
-
id: 18
username: eos_praesentium
color: '#229825'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: gus42
uuid: 3322ba65-6054-11ee-8c15-000d3a9285ca
name: 'Cristina Feeney'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
values:
-
uuid: 33239d77-6054-11ee-8c15-000d3a9285ca
is_hidden: false
is_user_value: false
is_visible: true
is_cleared: true
is_dropped: false
value: 1
value_to_display: '1'
type: d10
label: null
meta: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
total_value: 1
equation: 1d10
external_id: null
participants: []
-
direction: 180
velocity: 1
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: sipes.mac
uuid: 33253708-6054-11ee-8c15-000d3a9285ca
name: 'Moshe Lehner'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
room:
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: iste
slug: V_InOWI
custom_slug: null
settings:
chat:
backgroundColor: 0
deleteAfter: 30
fadeAfter: 10
isDiceExpanded: false
isDiceSorted: false
isUsernameVisible: true
isVisible: true
textColor: 16777215
textSize: sm
lighting:
ambientColor: 16777215
ambientIntensity: 0.5
spotlightColor: 16777215
spotlightIntensity: 0.33
participant:
defaultDiceTrayToGM: false
physics:
gravity: 9.82
throwSpeed: 30
roll:
allowPlayerRollUpdates: false
allowPlayerMoveDice: false
autoClear: 10
defaultClickBehavior: reroll
diceSize: 1
diceLimit: 25
diceTrayColor: 0
disableDiceOutline: false
disableDiceShadows: false
disableShakingSound: false
pickUp: 1
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
participants:
-
id: 19
username: saepe_facilis
color: '#71df02'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: pbruen
uuid: 33262718-6054-11ee-8c15-000d3a9285ca
name: 'Saul Hand'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
values:
-
uuid: 3327113f-6054-11ee-8c15-000d3a9285ca
is_hidden: true
is_user_value: false
is_visible: false
is_cleared: true
is_dropped: false
value: 3
value_to_display: '3'
type: d12
label: null
meta: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
total_value: 3
equation: 1d12
external_id: null
participants: []
properties:
type:
type: string
example: 'roll[]'
data:
type: array
example:
-
direction: 180
velocity: 1
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: madisyn22
uuid: 3321a2e7-6054-11ee-8c15-000d3a9285ca
name: 'Meta Ferry'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
room:
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: sed
slug: BNwkMUG
custom_slug: null
settings:
chat:
backgroundColor: 0
deleteAfter: 30
fadeAfter: 10
isDiceExpanded: false
isDiceSorted: false
isUsernameVisible: true
isVisible: true
textColor: 16777215
textSize: sm
lighting:
ambientColor: 16777215
ambientIntensity: 0.5
spotlightColor: 16777215
spotlightIntensity: 0.33
participant:
defaultDiceTrayToGM: false
physics:
gravity: 9.82
throwSpeed: 30
roll:
allowPlayerRollUpdates: false
allowPlayerMoveDice: false
autoClear: 10
defaultClickBehavior: reroll
diceSize: 1
diceLimit: 25
diceTrayColor: 0
disableDiceOutline: false
disableDiceShadows: false
disableShakingSound: false
pickUp: 1
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
participants:
-
id: 18
username: eos_praesentium
color: '#229825'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: gus42
uuid: 3322ba65-6054-11ee-8c15-000d3a9285ca
name: 'Cristina Feeney'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
values:
-
uuid: 33239d77-6054-11ee-8c15-000d3a9285ca
is_hidden: false
is_user_value: false
is_visible: true
is_cleared: true
is_dropped: false
value: 1
value_to_display: '1'
type: d10
label: null
meta: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
total_value: 1
equation: 1d10
external_id: null
participants: []
-
direction: 180
velocity: 1
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: sipes.mac
uuid: 33253708-6054-11ee-8c15-000d3a9285ca
name: 'Moshe Lehner'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
room:
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: iste
slug: V_InOWI
custom_slug: null
settings:
chat:
backgroundColor: 0
deleteAfter: 30
fadeAfter: 10
isDiceExpanded: false
isDiceSorted: false
isUsernameVisible: true
isVisible: true
textColor: 16777215
textSize: sm
lighting:
ambientColor: 16777215
ambientIntensity: 0.5
spotlightColor: 16777215
spotlightIntensity: 0.33
participant:
defaultDiceTrayToGM: false
physics:
gravity: 9.82
throwSpeed: 30
roll:
allowPlayerRollUpdates: false
allowPlayerMoveDice: false
autoClear: 10
defaultClickBehavior: reroll
diceSize: 1
diceLimit: 25
diceTrayColor: 0
disableDiceOutline: false
disableDiceShadows: false
disableShakingSound: false
pickUp: 1
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
participants:
-
id: 19
username: saepe_facilis
color: '#71df02'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: pbruen
uuid: 33262718-6054-11ee-8c15-000d3a9285ca
name: 'Saul Hand'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
values:
-
uuid: 3327113f-6054-11ee-8c15-000d3a9285ca
is_hidden: true
is_user_value: false
is_visible: false
is_cleared: true
is_dropped: false
value: 3
value_to_display: '3'
type: d12
label: null
meta: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
total_value: 3
equation: 1d12
external_id: null
participants: []
items:
type: object
properties:
direction:
type: integer
example: 180
velocity:
type: integer
example: 1
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
user:
type: object
properties:
username:
type: string
example: madisyn22
uuid:
type: string
example: 3321a2e7-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Meta Ferry'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
room:
type: object
properties:
is_public:
type: boolean
example: true
name:
type: string
example: 'Untitled Room'
bg_file_path:
type: string
example: null
passcode:
type: string
example: sed
slug:
type: string
example: BNwkMUG
custom_slug:
type: string
example: null
settings:
type: object
properties:
chat:
type: object
properties:
backgroundColor:
type: integer
example: 0
deleteAfter:
type: integer
example: 30
fadeAfter:
type: integer
example: 10
isDiceExpanded:
type: boolean
example: false
isDiceSorted:
type: boolean
example: false
isUsernameVisible:
type: boolean
example: true
isVisible:
type: boolean
example: true
textColor:
type: integer
example: 16777215
textSize:
type: string
example: sm
lighting:
type: object
properties:
ambientColor:
type: integer
example: 16777215
ambientIntensity:
type: number
example: 0.5
spotlightColor:
type: integer
example: 16777215
spotlightIntensity:
type: number
example: 0.33
participant:
type: object
properties:
defaultDiceTrayToGM:
type: boolean
example: false
physics:
type: object
properties:
gravity:
type: number
example: 9.82
throwSpeed:
type: integer
example: 30
roll:
type: object
properties:
allowPlayerRollUpdates:
type: boolean
example: false
allowPlayerMoveDice:
type: boolean
example: false
autoClear:
type: integer
example: 10
defaultClickBehavior:
type: string
example: reroll
diceSize:
type: integer
example: 1
diceLimit:
type: integer
example: 25
diceTrayColor:
type: integer
example: 0
disableDiceOutline:
type: boolean
example: false
disableDiceShadows:
type: boolean
example: false
disableShakingSound:
type: boolean
example: false
pickUp:
type: integer
example: 1
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
deleted_at:
type: string
example: null
participants:
type: array
example:
-
id: 18
username: eos_praesentium
color: '#229825'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: gus42
uuid: 3322ba65-6054-11ee-8c15-000d3a9285ca
name: 'Cristina Feeney'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
items:
type: object
properties:
id:
type: integer
example: 18
username:
type: string
example: eos_praesentium
color:
type: string
example: '#229825'
position:
type: integer
example: 0
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
deleted_at:
type: string
example: null
user:
type: object
properties:
username: { type: string, example: gus42 }
uuid: { type: string, example: 3322ba65-6054-11ee-8c15-000d3a9285ca }
name: { type: string, example: 'Cristina Feeney' }
created_at: { type: string, example: '2023-10-01T12:15:24.000000Z' }
updated_at: { type: string, example: '2023-10-01T12:15:24.000000Z' }
values:
type: array
example:
-
uuid: 33239d77-6054-11ee-8c15-000d3a9285ca
is_hidden: false
is_user_value: false
is_visible: true
is_cleared: true
is_dropped: false
value: 1
value_to_display: '1'
type: d10
label: null
meta: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
items:
type: object
properties:
uuid:
type: string
example: 33239d77-6054-11ee-8c15-000d3a9285ca
is_hidden:
type: boolean
example: false
is_user_value:
type: boolean
example: false
is_visible:
type: boolean
example: true
is_cleared:
type: boolean
example: true
is_dropped:
type: boolean
example: false
value:
type: integer
example: 1
value_to_display:
type: string
example: '1'
type:
type: string
example: d10
label:
type: string
example: null
meta:
type: string
example: null
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
total_value:
type: integer
example: 1
equation:
type: string
example: 1d10
external_id:
type: string
example: null
participants:
type: array
example: []
tags:
- Roll
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
rolls:
type: array
description: 'List of rolls.'
example:
-
uuid: '1'
dice:
-
uuid: '1'
is_hidden: true
items:
type: object
properties:
uuid:
type: required
description: 'Roll ID'
example: 0caa6cff-ab8b-3cca-81e8-47e0b5e33db3
dice:
type: array
description: 'List of partial dice rolls.'
example:
-
uuid: '1'
is_hidden: true
items:
type: object
properties:
is_visible:
type: boolean
description: 'Roll value hidden'
example: true
is_cleared:
type: boolean
description: 'Roll value cleared'
example: false
room:
type: string
description: ''
example: a
required:
- dice
required:
- rolls
delete:
summary: 'Delete rolls'
operationId: deleteRolls
description: 'Delete rolls from a given room'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
204:
description: ''
tags:
- Roll
'/api/1.0/roll/{id}':
get:
summary: 'Get a Roll'
operationId: getARoll
description: 'Fetch roll information including the user and optional room information'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
direction: 180
velocity: 1
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: cwalker
uuid: 33150ca9-6054-11ee-8c15-000d3a9285ca
name: 'Vince Streich'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
room:
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: molestias
slug: xEvtpSF
custom_slug: null
settings:
chat:
backgroundColor: 0
deleteAfter: 30
fadeAfter: 10
isDiceExpanded: false
isDiceSorted: false
isUsernameVisible: true
isVisible: true
textColor: 16777215
textSize: sm
lighting:
ambientColor: 16777215
ambientIntensity: 0.5
spotlightColor: 16777215
spotlightIntensity: 0.33
participant:
defaultDiceTrayToGM: false
physics:
gravity: 9.82
throwSpeed: 30
roll:
allowPlayerRollUpdates: false
allowPlayerMoveDice: false
autoClear: 10
defaultClickBehavior: reroll
diceSize: 1
diceLimit: 25
diceTrayColor: 0
disableDiceOutline: false
disableDiceShadows: false
disableShakingSound: false
pickUp: 1
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
participants:
-
id: 16
username: in_excepturi
color: '#210c2b'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: kuvalis.chelsey
uuid: 331619a8-6054-11ee-8c15-000d3a9285ca
name: 'Amaya Wolff'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
values:
-
uuid: 3317039c-6054-11ee-8c15-000d3a9285ca
is_hidden: true
is_user_value: false
is_visible: false
is_cleared: true
is_dropped: false
value: 11
value_to_display: '11'
type: d12
label: null
meta: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
total_value: 11
equation: 1d12
external_id: null
participants: []
properties:
data:
type: object
properties:
direction:
type: integer
example: 180
velocity:
type: integer
example: 1
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
user:
type: object
properties:
username:
type: string
example: cwalker
uuid:
type: string
example: 33150ca9-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Vince Streich'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
room:
type: object
properties:
is_public:
type: boolean
example: true
name:
type: string
example: 'Untitled Room'
bg_file_path:
type: string
example: null
passcode:
type: string
example: molestias
slug:
type: string
example: xEvtpSF
custom_slug:
type: string
example: null
settings:
type: object
properties:
chat:
type: object
properties:
backgroundColor:
type: integer
example: 0
deleteAfter:
type: integer
example: 30
fadeAfter:
type: integer
example: 10
isDiceExpanded:
type: boolean
example: false
isDiceSorted:
type: boolean
example: false
isUsernameVisible:
type: boolean
example: true
isVisible:
type: boolean
example: true
textColor:
type: integer
example: 16777215
textSize:
type: string
example: sm
lighting:
type: object
properties:
ambientColor:
type: integer
example: 16777215
ambientIntensity:
type: number
example: 0.5
spotlightColor:
type: integer
example: 16777215
spotlightIntensity:
type: number
example: 0.33
participant:
type: object
properties:
defaultDiceTrayToGM:
type: boolean
example: false
physics:
type: object
properties:
gravity:
type: number
example: 9.82
throwSpeed:
type: integer
example: 30
roll:
type: object
properties:
allowPlayerRollUpdates:
type: boolean
example: false
allowPlayerMoveDice:
type: boolean
example: false
autoClear:
type: integer
example: 10
defaultClickBehavior:
type: string
example: reroll
diceSize:
type: integer
example: 1
diceLimit:
type: integer
example: 25
diceTrayColor:
type: integer
example: 0
disableDiceOutline:
type: boolean
example: false
disableDiceShadows:
type: boolean
example: false
disableShakingSound:
type: boolean
example: false
pickUp:
type: integer
example: 1
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
deleted_at:
type: string
example: null
participants:
type: array
example:
-
id: 16
username: in_excepturi
color: '#210c2b'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: kuvalis.chelsey
uuid: 331619a8-6054-11ee-8c15-000d3a9285ca
name: 'Amaya Wolff'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
items:
type: object
properties:
id:
type: integer
example: 16
username:
type: string
example: in_excepturi
color:
type: string
example: '#210c2b'
position:
type: integer
example: 0
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
deleted_at:
type: string
example: null
user:
type: object
properties:
username:
type: string
example: kuvalis.chelsey
uuid:
type: string
example: 331619a8-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Amaya Wolff'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
values:
type: array
example:
-
uuid: 3317039c-6054-11ee-8c15-000d3a9285ca
is_hidden: true
is_user_value: false
is_visible: false
is_cleared: true
is_dropped: false
value: 11
value_to_display: '11'
type: d12
label: null
meta: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
items:
type: object
properties:
uuid:
type: string
example: 3317039c-6054-11ee-8c15-000d3a9285ca
is_hidden:
type: boolean
example: true
is_user_value:
type: boolean
example: false
is_visible:
type: boolean
example: false
is_cleared:
type: boolean
example: true
is_dropped:
type: boolean
example: false
value:
type: integer
example: 11
value_to_display:
type: string
example: '11'
type:
type: string
example: d12
label:
type: string
example: null
meta:
type: string
example: null
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
total_value:
type: integer
example: 11
equation:
type: string
example: 1d12
external_id:
type: string
example: null
participants:
type: array
example: []
tags:
- Roll
patch:
summary: 'Update a Roll'
operationId: updateARoll
description: 'Pickup dice from the board or unhide dice to players'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
direction: 180
velocity: 1
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: dach.christian
uuid: 331b1b10-6054-11ee-8c15-000d3a9285ca
name: 'Madeline Mosciski'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
room:
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: pariatur
slug: olHEQ57
custom_slug: null
settings:
chat:
backgroundColor: 0
deleteAfter: 30
fadeAfter: 10
isDiceExpanded: false
isDiceSorted: false
isUsernameVisible: true
isVisible: true
textColor: 16777215
textSize: sm
lighting:
ambientColor: 16777215
ambientIntensity: 0.5
spotlightColor: 16777215
spotlightIntensity: 0.33
participant:
defaultDiceTrayToGM: false
physics:
gravity: 9.82
throwSpeed: 30
roll:
allowPlayerRollUpdates: false
allowPlayerMoveDice: false
autoClear: 10
defaultClickBehavior: reroll
diceSize: 1
diceLimit: 25
diceTrayColor: 0
disableDiceOutline: false
disableDiceShadows: false
disableShakingSound: false
pickUp: 1
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
participants:
-
id: 17
username: et_illum
color: '#02530c'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: baumbach.telly
uuid: 331c2d79-6054-11ee-8c15-000d3a9285ca
name: 'Prof. Edna Cassin'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
values:
-
uuid: 331d172b-6054-11ee-8c15-000d3a9285ca
is_hidden: false
is_user_value: true
is_visible: false
is_cleared: false
is_dropped: false
value: 4
value_to_display: '4'
type: d4
label: null
meta: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
total_value: 4
equation: 1d4
external_id: null
participants: []
properties:
data:
type: object
properties:
direction:
type: integer
example: 180
velocity:
type: integer
example: 1
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
user:
type: object
properties:
username:
type: string
example: dach.christian
uuid:
type: string
example: 331b1b10-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Madeline Mosciski'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
room:
type: object
properties:
is_public:
type: boolean
example: true
name:
type: string
example: 'Untitled Room'
bg_file_path:
type: string
example: null
passcode:
type: string
example: pariatur
slug:
type: string
example: olHEQ57
custom_slug:
type: string
example: null
settings:
type: object
properties:
chat:
type: object
properties:
backgroundColor:
type: integer
example: 0
deleteAfter:
type: integer
example: 30
fadeAfter:
type: integer
example: 10
isDiceExpanded:
type: boolean
example: false
isDiceSorted:
type: boolean
example: false
isUsernameVisible:
type: boolean
example: true
isVisible:
type: boolean
example: true
textColor:
type: integer
example: 16777215
textSize:
type: string
example: sm
lighting:
type: object
properties:
ambientColor:
type: integer
example: 16777215
ambientIntensity:
type: number
example: 0.5
spotlightColor:
type: integer
example: 16777215
spotlightIntensity:
type: number
example: 0.33
participant:
type: object
properties:
defaultDiceTrayToGM:
type: boolean
example: false
physics:
type: object
properties:
gravity:
type: number
example: 9.82
throwSpeed:
type: integer
example: 30
roll:
type: object
properties:
allowPlayerRollUpdates:
type: boolean
example: false
allowPlayerMoveDice:
type: boolean
example: false
autoClear:
type: integer
example: 10
defaultClickBehavior:
type: string
example: reroll
diceSize:
type: integer
example: 1
diceLimit:
type: integer
example: 25
diceTrayColor:
type: integer
example: 0
disableDiceOutline:
type: boolean
example: false
disableDiceShadows:
type: boolean
example: false
disableShakingSound:
type: boolean
example: false
pickUp:
type: integer
example: 1
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
deleted_at:
type: string
example: null
participants:
type: array
example:
-
id: 17
username: et_illum
color: '#02530c'
position: 0
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
deleted_at: null
user:
username: baumbach.telly
uuid: 331c2d79-6054-11ee-8c15-000d3a9285ca
name: 'Prof. Edna Cassin'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
items:
type: object
properties:
id:
type: integer
example: 17
username:
type: string
example: et_illum
color:
type: string
example: '#02530c'
position:
type: integer
example: 0
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
deleted_at:
type: string
example: null
user:
type: object
properties:
username:
type: string
example: baumbach.telly
uuid:
type: string
example: 331c2d79-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Prof. Edna Cassin'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
values:
type: array
example:
-
uuid: 331d172b-6054-11ee-8c15-000d3a9285ca
is_hidden: false
is_user_value: true
is_visible: false
is_cleared: false
is_dropped: false
value: 4
value_to_display: '4'
type: d4
label: null
meta: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
items:
type: object
properties:
uuid:
type: string
example: 331d172b-6054-11ee-8c15-000d3a9285ca
is_hidden:
type: boolean
example: false
is_user_value:
type: boolean
example: true
is_visible:
type: boolean
example: false
is_cleared:
type: boolean
example: false
is_dropped:
type: boolean
example: false
value:
type: integer
example: 4
value_to_display:
type: string
example: '4'
type:
type: string
example: d4
label:
type: string
example: null
meta:
type: string
example: null
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
total_value:
type: integer
example: 4
equation:
type: string
example: 1d4
external_id:
type: string
example: null
participants:
type: array
example: []
tags:
- Roll
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
room:
type: string
description: ''
example: perspiciatis
dice:
type: array
description: 'List of partial dice rolls.'
example:
-
uuid: '1'
is_hidden: true
items:
type: object
properties:
uuid:
type: string
description: ''
example: 69bdb9e5-578f-30f1-a04c-044a70432d08
is_visible:
type: boolean
description: 'Roll value hidden'
example: true
is_cleared:
type: boolean
description: 'Roll value cleared'
example: false
is_dropped:
type: boolean
description: ''
example: true
is_hidden:
type: boolean
description: ''
example: true
meta:
type: object
description: 'Optional data that is not critical to the functionality of a die roll but could be useful to store for display or informational purposes.'
example: []
properties: []
required:
- dice
parameters:
-
in: path
name: id
description: 'Roll ID'
example: ex
required: true
schema:
type: string
/api/1.0/share:
get:
summary: 'List Share Requests'
operationId: listShareRequests
description: "\n\nFetch a list of active and inactive share requests."
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
type: 'share[]'
data:
-
limit: 5
expires_at: '2023-10-01T12:15:24.000000Z'
uuid: a6d4294d-fde9-3013-8543-921592c8b179
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: waylon32
uuid: 332cc2b5-6054-11ee-8c15-000d3a9285ca
name: 'Maxie Davis'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
theme:
slug: et-est-aliquam
is_available: true
is_extendable: true
is_discoverable: true
name: Mr.
description: 'Sit doloremque cum ea eos non omnis qui. Dolores corrupti consequuntur mollitia tenetur ut laboriosam id. Laboriosam nihil tempore illum reprehenderit qui.'
form_state: null
deleted_at: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
-
limit: 5
expires_at: '2023-10-01T12:15:24.000000Z'
uuid: 463fbc0b-a6b2-392f-a064-80e5ed395d4e
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: sheldon74
uuid: 332e5882-6054-11ee-8c15-000d3a9285ca
name: 'Citlalli Hoeger III'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
theme:
slug: exercitationem-vero
is_available: true
is_extendable: true
is_discoverable: true
name: Prof.
description: 'Ipsam ad et et eaque odit provident corporis. Molestiae voluptatem asperiores delectus excepturi fugit rerum. Et asperiores possimus ut et delectus. Sunt praesentium eum corrupti cumque enim qui est et.'
form_state: null
deleted_at: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
properties:
type:
type: string
example: 'share[]'
data:
type: array
example:
-
limit: 5
expires_at: '2023-10-01T12:15:24.000000Z'
uuid: a6d4294d-fde9-3013-8543-921592c8b179
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: waylon32
uuid: 332cc2b5-6054-11ee-8c15-000d3a9285ca
name: 'Maxie Davis'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
theme:
slug: et-est-aliquam
is_available: true
is_extendable: true
is_discoverable: true
name: Mr.
description: 'Sit doloremque cum ea eos non omnis qui. Dolores corrupti consequuntur mollitia tenetur ut laboriosam id. Laboriosam nihil tempore illum reprehenderit qui.'
form_state: null
deleted_at: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
-
limit: 5
expires_at: '2023-10-01T12:15:24.000000Z'
uuid: 463fbc0b-a6b2-392f-a064-80e5ed395d4e
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: sheldon74
uuid: 332e5882-6054-11ee-8c15-000d3a9285ca
name: 'Citlalli Hoeger III'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
theme:
slug: exercitationem-vero
is_available: true
is_extendable: true
is_discoverable: true
name: Prof.
description: 'Ipsam ad et et eaque odit provident corporis. Molestiae voluptatem asperiores delectus excepturi fugit rerum. Et asperiores possimus ut et delectus. Sunt praesentium eum corrupti cumque enim qui est et.'
form_state: null
deleted_at: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
items:
type: object
properties:
limit:
type: integer
example: 5
expires_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
uuid:
type: string
example: a6d4294d-fde9-3013-8543-921592c8b179
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
user:
type: object
properties:
username:
type: string
example: waylon32
uuid:
type: string
example: 332cc2b5-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Maxie Davis'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
theme:
type: object
properties:
slug:
type: string
example: et-est-aliquam
is_available:
type: boolean
example: true
is_extendable:
type: boolean
example: true
is_discoverable:
type: boolean
example: true
name:
type: string
example: Mr.
description:
type: string
example: 'Sit doloremque cum ea eos non omnis qui. Dolores corrupti consequuntur mollitia tenetur ut laboriosam id. Laboriosam nihil tempore illum reprehenderit qui.'
form_state:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
tags:
- 'Share Dice'
post:
summary: 'Create Share Request'
operationId: createShareRequest
description: 'Create a share request for a given theme.'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
data:
limit: 5
expires_at: '2023-10-01T12:15:24.000000Z'
uuid: 0040e74a-987d-3191-9a57-a639c50d6f8d
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: moen.sydnee
uuid: 33314e38-6054-11ee-8c15-000d3a9285ca
name: 'Trever Reilly'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
theme:
slug: quam-eos-et
is_available: true
is_extendable: true
is_discoverable: true
name: Dr.
description: 'Velit voluptas ab nobis nobis qui. Id commodi est a soluta. Cupiditate reprehenderit enim vero natus est. Iste ab qui porro perspiciatis dicta enim corporis.'
form_state: null
deleted_at: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
properties:
data:
type: object
properties:
limit:
type: integer
example: 5
expires_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
uuid:
type: string
example: 0040e74a-987d-3191-9a57-a639c50d6f8d
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
user:
type: object
properties:
username:
type: string
example: moen.sydnee
uuid:
type: string
example: 33314e38-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Trever Reilly'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
theme:
type: object
properties:
slug:
type: string
example: quam-eos-et
is_available:
type: boolean
example: true
is_extendable:
type: boolean
example: true
is_discoverable:
type: boolean
example: true
name:
type: string
example: Dr.
description:
type: string
example: 'Velit voluptas ab nobis nobis qui. Id commodi est a soluta. Cupiditate reprehenderit enim vero natus est. Iste ab qui porro perspiciatis dicta enim corporis.'
form_state:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
tags:
- 'Share Dice'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
slug:
type: string
description: 'Theme slug.'
example: dddice-standard
limit:
type: integer
description: 'Number of times this share request can be accepted'
example: 13
expires_at:
type: string
description: 'Expiration date or datetime'
example: ex
required:
- slug
'/api/1.0/share/{id}':
get:
summary: 'Get Share Request'
operationId: getShareRequest
description: "\n\nGet information about a share request."
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
limit: 5
expires_at: '2023-10-01T12:15:24.000000Z'
uuid: fdb5fdc3-7271-3859-8242-9bd1fe2e7880
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: howell.skye
uuid: 3333c219-6054-11ee-8c15-000d3a9285ca
name: 'Mrs. Dariana McCullough MD'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
theme:
slug: suscipit-et-et
is_available: true
is_extendable: true
is_discoverable: true
name: Dr.
description: 'Ex sed laboriosam id pariatur quos cumque. Sit vel maiores dolorem sed. Omnis molestias aperiam tenetur est nihil porro. Autem eius fugiat recusandae distinctio numquam.'
form_state: null
deleted_at: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
properties:
data:
type: object
properties:
limit:
type: integer
example: 5
expires_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
uuid:
type: string
example: fdb5fdc3-7271-3859-8242-9bd1fe2e7880
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
user:
type: object
properties:
username:
type: string
example: howell.skye
uuid:
type: string
example: 3333c219-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Mrs. Dariana McCullough MD'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
theme:
type: object
properties:
slug:
type: string
example: suscipit-et-et
is_available:
type: boolean
example: true
is_extendable:
type: boolean
example: true
is_discoverable:
type: boolean
example: true
name:
type: string
example: Dr.
description:
type: string
example: 'Ex sed laboriosam id pariatur quos cumque. Sit vel maiores dolorem sed. Omnis molestias aperiam tenetur est nihil porro. Autem eius fugiat recusandae distinctio numquam.'
form_state:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
tags:
- 'Share Dice'
patch:
summary: 'Update Share Request'
operationId: updateShareRequest
description: "\n\nUpdate information about a share request."
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
limit: 5
expires_at: '2023-10-01T12:15:24.000000Z'
uuid: 05812913-d875-32ac-956e-3a1e81de91ef
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: axel.ullrich
uuid: 333623b3-6054-11ee-8c15-000d3a9285ca
name: 'Nyah Schowalter'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
theme:
slug: omnis-magnam
is_available: true
is_extendable: true
is_discoverable: true
name: Prof.
description: 'Ipsa delectus laudantium autem maiores provident est non. Nihil excepturi impedit mollitia ut aut tempora dicta. Vel atque ab ratione minus in aut recusandae quaerat.'
form_state: null
deleted_at: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
properties:
data:
type: object
properties:
limit:
type: integer
example: 5
expires_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
uuid:
type: string
example: 05812913-d875-32ac-956e-3a1e81de91ef
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
user:
type: object
properties:
username:
type: string
example: axel.ullrich
uuid:
type: string
example: 333623b3-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Nyah Schowalter'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
theme:
type: object
properties:
slug:
type: string
example: omnis-magnam
is_available:
type: boolean
example: true
is_extendable:
type: boolean
example: true
is_discoverable:
type: boolean
example: true
name:
type: string
example: Prof.
description:
type: string
example: 'Ipsa delectus laudantium autem maiores provident est non. Nihil excepturi impedit mollitia ut aut tempora dicta. Vel atque ab ratione minus in aut recusandae quaerat.'
form_state:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
tags:
- 'Share Dice'
delete:
summary: 'Delete Share Request'
operationId: deleteShareRequest
description: "\n\nDelete a share request which will invalidate any shared URLs"
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
204:
description: ''
tags:
- 'Share Dice'
post:
summary: 'Accept Share Request'
operationId: acceptShareRequest
description: "Accept a user's share request which will add the specified theme to your **Digital Dice Box**.\n\nYou can retrieve and modify this theme from your **Digitial Dice Box** by using the [DiceBox](#dice-box) endpoints."
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
limit: 5
expires_at: '2023-10-01T12:15:24.000000Z'
uuid: 1fe33954-1106-3eb1-8a6d-37cfd5874311
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
user:
username: sigmund94
uuid: 3339fe1c-6054-11ee-8c15-000d3a9285ca
name: 'Patricia Bergstrom'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
theme:
slug: vero-dolore-atque
is_available: true
is_extendable: true
is_discoverable: true
name: Dr.
description: 'Qui ducimus sequi fugiat quia et alias rerum velit. Aspernatur vero quis id repudiandae molestias harum earum. Est nostrum repudiandae animi ab aspernatur eum. Expedita nihil commodi nihil quas aut doloremque.'
form_state: null
deleted_at: null
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
properties:
data:
type: object
properties:
limit:
type: integer
example: 5
expires_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
uuid:
type: string
example: 1fe33954-1106-3eb1-8a6d-37cfd5874311
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
user:
type: object
properties:
username:
type: string
example: sigmund94
uuid:
type: string
example: 3339fe1c-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Patricia Bergstrom'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
theme:
type: object
properties:
slug:
type: string
example: vero-dolore-atque
is_available:
type: boolean
example: true
is_extendable:
type: boolean
example: true
is_discoverable:
type: boolean
example: true
name:
type: string
example: Dr.
description:
type: string
example: 'Qui ducimus sequi fugiat quia et alias rerum velit. Aspernatur vero quis id repudiandae molestias harum earum. Est nostrum repudiandae animi ab aspernatur eum. Expedita nihil commodi nihil quas aut doloremque.'
form_state:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
tags:
- 'Share Dice'
parameters:
-
in: path
name: id
description: 'The ID of the share request'
example: ipsa
required: true
schema:
type: string
/api/1.0/user:
get:
summary: 'Get Authenticated User'
operationId: getAuthenticatedUser
description: 'Get the current authenticated user.'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
type: user
data:
name: 'Aubrey Ward'
username: hudson.herbert
updated_at: '2023-10-01T12:15:25.000000Z'
created_at: '2023-10-01T12:15:25.000000Z'
rooms:
-
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: non
slug: Rs4SKyY
custom_slug: null
settings:
chat:
backgroundColor: 0
deleteAfter: 30
fadeAfter: 10
isDiceExpanded: false
isDiceSorted: false
isUsernameVisible: true
isVisible: true
textColor: 16777215
textSize: sm
lighting:
ambientColor: 16777215
ambientIntensity: 0.5
spotlightColor: 16777215
spotlightIntensity: 0.33
participant:
defaultDiceTrayToGM: false
physics:
gravity: 9.82
throwSpeed: 30
roll:
allowPlayerRollUpdates: false
allowPlayerMoveDice: false
autoClear: 10
defaultClickBehavior: reroll
diceSize: 1
diceLimit: 25
diceTrayColor: 0
disableDiceOutline: false
disableDiceShadows: false
disableShakingSound: false
pickUp: 1
created_at: '2023-10-01T12:15:25.000000Z'
updated_at: '2023-10-01T12:15:25.000000Z'
deleted_at: null
properties:
type:
type: string
example: user
data:
type: object
properties:
name:
type: string
example: 'Aubrey Ward'
username:
type: string
example: hudson.herbert
updated_at:
type: string
example: '2023-10-01T12:15:25.000000Z'
created_at:
type: string
example: '2023-10-01T12:15:25.000000Z'
rooms:
type: array
example:
-
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: non
slug: Rs4SKyY
custom_slug: null
settings:
chat:
backgroundColor: 0
deleteAfter: 30
fadeAfter: 10
isDiceExpanded: false
isDiceSorted: false
isUsernameVisible: true
isVisible: true
textColor: 16777215
textSize: sm
lighting:
ambientColor: 16777215
ambientIntensity: 0.5
spotlightColor: 16777215
spotlightIntensity: 0.33
participant:
defaultDiceTrayToGM: false
physics:
gravity: 9.82
throwSpeed: 30
roll:
allowPlayerRollUpdates: false
allowPlayerMoveDice: false
autoClear: 10
defaultClickBehavior: reroll
diceSize: 1
diceLimit: 25
diceTrayColor: 0
disableDiceOutline: false
disableDiceShadows: false
disableShakingSound: false
pickUp: 1
created_at: '2023-10-01T12:15:25.000000Z'
updated_at: '2023-10-01T12:15:25.000000Z'
deleted_at: null
items:
type: object
properties:
is_public:
type: boolean
example: true
name:
type: string
example: 'Untitled Room'
bg_file_path:
type: string
example: null
passcode:
type: string
example: non
slug:
type: string
example: Rs4SKyY
custom_slug:
type: string
example: null
settings:
type: object
properties:
chat:
type: object
properties:
backgroundColor:
type: integer
example: 0
deleteAfter:
type: integer
example: 30
fadeAfter:
type: integer
example: 10
isDiceExpanded:
type: boolean
example: false
isDiceSorted:
type: boolean
example: false
isUsernameVisible:
type: boolean
example: true
isVisible:
type: boolean
example: true
textColor:
type: integer
example: 16777215
textSize:
type: string
example: sm
lighting:
type: object
properties:
ambientColor:
type: integer
example: 16777215
ambientIntensity:
type: number
example: 0.5
spotlightColor:
type: integer
example: 16777215
spotlightIntensity:
type: number
example: 0.33
participant:
type: object
properties:
defaultDiceTrayToGM:
type: boolean
example: false
physics:
type: object
properties:
gravity:
type: number
example: 9.82
throwSpeed:
type: integer
example: 30
roll:
type: object
properties:
allowPlayerRollUpdates:
type: boolean
example: false
allowPlayerMoveDice:
type: boolean
example: false
autoClear:
type: integer
example: 10
defaultClickBehavior:
type: string
example: reroll
diceSize:
type: integer
example: 1
diceLimit:
type: integer
example: 25
diceTrayColor:
type: integer
example: 0
disableDiceOutline:
type: boolean
example: false
disableDiceShadows:
type: boolean
example: false
disableShakingSound:
type: boolean
example: false
pickUp:
type: integer
example: 1
created_at:
type: string
example: '2023-10-01T12:15:25.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:25.000000Z'
deleted_at:
type: string
example: null
tags:
- User
post:
summary: 'Create Guest User'
operationId: createGuestUser
description: "Create a guest user to communicate with other API endpoints. Returns a token that can be used to fetch a user.\n\nThis route is rate-limited to 1 account/24-hour."
parameters: []
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
type: user
data:
name: 'Mrs. Jakayla Emard'
username: rosanna.barton
updated_at: '2023-10-01T12:15:25.000000Z'
created_at: '2023-10-01T12:15:25.000000Z'
rooms:
-
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: sunt
slug: Q2SeDal
custom_slug: null
settings:
chat:
backgroundColor: 0
deleteAfter: 30
fadeAfter: 10
isDiceExpanded: false
isDiceSorted: false
isUsernameVisible: true
isVisible: true
textColor: 16777215
textSize: sm
lighting:
ambientColor: 16777215
ambientIntensity: 0.5
spotlightColor: 16777215
spotlightIntensity: 0.33
participant:
defaultDiceTrayToGM: false
physics:
gravity: 9.82
throwSpeed: 30
roll:
allowPlayerRollUpdates: false
allowPlayerMoveDice: false
autoClear: 10
defaultClickBehavior: reroll
diceSize: 1
diceLimit: 25
diceTrayColor: 0
disableDiceOutline: false
disableDiceShadows: false
disableShakingSound: false
pickUp: 1
created_at: '2023-10-01T12:15:25.000000Z'
updated_at: '2023-10-01T12:15:25.000000Z'
deleted_at: null
properties:
type:
type: string
example: user
data:
type: object
properties:
name:
type: string
example: 'Mrs. Jakayla Emard'
username:
type: string
example: rosanna.barton
updated_at:
type: string
example: '2023-10-01T12:15:25.000000Z'
created_at:
type: string
example: '2023-10-01T12:15:25.000000Z'
rooms:
type: array
example:
-
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: sunt
slug: Q2SeDal
custom_slug: null
settings:
chat:
backgroundColor: 0
deleteAfter: 30
fadeAfter: 10
isDiceExpanded: false
isDiceSorted: false
isUsernameVisible: true
isVisible: true
textColor: 16777215
textSize: sm
lighting:
ambientColor: 16777215
ambientIntensity: 0.5
spotlightColor: 16777215
spotlightIntensity: 0.33
participant:
defaultDiceTrayToGM: false
physics:
gravity: 9.82
throwSpeed: 30
roll:
allowPlayerRollUpdates: false
allowPlayerMoveDice: false
autoClear: 10
defaultClickBehavior: reroll
diceSize: 1
diceLimit: 25
diceTrayColor: 0
disableDiceOutline: false
disableDiceShadows: false
disableShakingSound: false
pickUp: 1
created_at: '2023-10-01T12:15:25.000000Z'
updated_at: '2023-10-01T12:15:25.000000Z'
deleted_at: null
items:
type: object
properties:
is_public:
type: boolean
example: true
name:
type: string
example: 'Untitled Room'
bg_file_path:
type: string
example: null
passcode:
type: string
example: sunt
slug:
type: string
example: Q2SeDal
custom_slug:
type: string
example: null
settings:
type: object
properties:
chat:
type: object
properties:
backgroundColor:
type: integer
example: 0
deleteAfter:
type: integer
example: 30
fadeAfter:
type: integer
example: 10
isDiceExpanded:
type: boolean
example: false
isDiceSorted:
type: boolean
example: false
isUsernameVisible:
type: boolean
example: true
isVisible:
type: boolean
example: true
textColor:
type: integer
example: 16777215
textSize:
type: string
example: sm
lighting:
type: object
properties:
ambientColor:
type: integer
example: 16777215
ambientIntensity:
type: number
example: 0.5
spotlightColor:
type: integer
example: 16777215
spotlightIntensity:
type: number
example: 0.33
participant:
type: object
properties:
defaultDiceTrayToGM:
type: boolean
example: false
physics:
type: object
properties:
gravity:
type: number
example: 9.82
throwSpeed:
type: integer
example: 30
roll:
type: object
properties:
allowPlayerRollUpdates:
type: boolean
example: false
allowPlayerMoveDice:
type: boolean
example: false
autoClear:
type: integer
example: 10
defaultClickBehavior:
type: string
example: reroll
diceSize:
type: integer
example: 1
diceLimit:
type: integer
example: 25
diceTrayColor:
type: integer
example: 0
disableDiceOutline:
type: boolean
example: false
disableDiceShadows:
type: boolean
example: false
disableShakingSound:
type: boolean
example: false
pickUp:
type: integer
example: 1
created_at:
type: string
example: '2023-10-01T12:15:25.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:25.000000Z'
deleted_at:
type: string
example: null
tags:
- User
security: []
/api/1.0/user/token:
post:
summary: 'Create API Token'
operationId: createAPIToken
description: 'Returns a new API token for the authenticated user.'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
type: token
data: ''
properties:
type:
type: string
example: token
data:
type: string
example: ''
tags:
- User
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: ''
example: corrupti
'/api/1.0/user/token/{token}':
delete:
summary: 'Delete API Key'
operationId: deleteAPIKey
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
204:
description: ''
tags:
- User
parameters:
-
in: path
name: token
description: Token
example: similique
required: true
schema:
type: string
/api/1.0/dice-box:
get:
summary: 'List Dice Box Collection'
operationId: listDiceBoxCollection
description: 'Fetch a list of all dice in your **Digital Dice Box**.'
parameters:
-
in: query
name: filter
description: 'Filter themes by name'
example: doloremque
required: false
schema:
type: string
description: 'Filter themes by name'
example: doloremque
-
in: query
name: ids
description: 'Comma seperated list of themes IDs to get'
example: voluptatem
required: false
schema:
type: string
description: 'Comma seperated list of themes IDs to get'
example: voluptatem
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
type: 'theme[]'
data:
-
meshes:
d4: 'https://cdn.dddice.com/mesh/d04.fbx'
d6: 'https://cdn.dddice.com/mesh/d06.fbx'
d8: 'https://cdn.dddice.com/mesh/d08.fbx'
d10: 'https://cdn.dddice.com/mesh/d10.fbx'
d10x: 'https://cdn.dddice.com/mesh/d10.fbx'
d12: 'https://cdn.dddice.com/mesh/d12.fbx'
d20: 'https://cdn.dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://cdn.dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: est-eaque
name: Prof.
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Cumque aut ullam omnis ipsum cum nesciunt illum. Qui officia illo itaque quaerat possimus molestiae enim.'
user:
username: gbayer
uuid: 333d81c6-6054-11ee-8c15-000d3a9285ca
name: 'Joaquin Ward'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
-
meshes:
d4: 'https://cdn.dddice.com/mesh/d04.fbx'
d6: 'https://cdn.dddice.com/mesh/d06.fbx'
d8: 'https://cdn.dddice.com/mesh/d08.fbx'
d10: 'https://cdn.dddice.com/mesh/d10.fbx'
d10x: 'https://cdn.dddice.com/mesh/d10.fbx'
d12: 'https://cdn.dddice.com/mesh/d12.fbx'
d20: 'https://cdn.dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://cdn.dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: molestiae-incidunt-et
name: Prof.
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Illo eaque cumque modi amet sunt atque sed. Eos occaecati maiores odio harum consequatur culpa. Aut aliquid autem adipisci quis.'
user:
username: klein.cordell
uuid: 333f3b21-6054-11ee-8c15-000d3a9285ca
name: 'Mr. Marcos Okuneva'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
properties:
type:
type: string
example: 'theme[]'
data:
type: array
example:
-
meshes:
d4: 'https://cdn.dddice.com/mesh/d04.fbx'
d6: 'https://cdn.dddice.com/mesh/d06.fbx'
d8: 'https://cdn.dddice.com/mesh/d08.fbx'
d10: 'https://cdn.dddice.com/mesh/d10.fbx'
d10x: 'https://cdn.dddice.com/mesh/d10.fbx'
d12: 'https://cdn.dddice.com/mesh/d12.fbx'
d20: 'https://cdn.dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://cdn.dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: est-eaque
name: Prof.
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Cumque aut ullam omnis ipsum cum nesciunt illum. Qui officia illo itaque quaerat possimus molestiae enim.'
user:
username: gbayer
uuid: 333d81c6-6054-11ee-8c15-000d3a9285ca
name: 'Joaquin Ward'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
-
meshes:
d4: 'https://cdn.dddice.com/mesh/d04.fbx'
d6: 'https://cdn.dddice.com/mesh/d06.fbx'
d8: 'https://cdn.dddice.com/mesh/d08.fbx'
d10: 'https://cdn.dddice.com/mesh/d10.fbx'
d10x: 'https://cdn.dddice.com/mesh/d10.fbx'
d12: 'https://cdn.dddice.com/mesh/d12.fbx'
d20: 'https://cdn.dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://cdn.dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: molestiae-incidunt-et
name: Prof.
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Illo eaque cumque modi amet sunt atque sed. Eos occaecati maiores odio harum consequatur culpa. Aut aliquid autem adipisci quis.'
user:
username: klein.cordell
uuid: 333f3b21-6054-11ee-8c15-000d3a9285ca
name: 'Mr. Marcos Okuneva'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
items:
type: object
properties:
meshes:
type: object
properties:
d4:
type: string
example: 'https://cdn.dddice.com/mesh/d04.fbx'
d6:
type: string
example: 'https://cdn.dddice.com/mesh/d06.fbx'
d8:
type: string
example: 'https://cdn.dddice.com/mesh/d08.fbx'
d10:
type: string
example: 'https://cdn.dddice.com/mesh/d10.fbx'
d10x:
type: string
example: 'https://cdn.dddice.com/mesh/d10.fbx'
d12:
type: string
example: 'https://cdn.dddice.com/mesh/d12.fbx'
d20:
type: string
example: 'https://cdn.dddice.com/mesh/d20.fbx'
available_dice:
type: array
example:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
items:
type: string
physics:
type: object
properties:
inertia:
type: object
properties:
d4:
type: integer
example: 5
d6:
type: integer
example: 12
d8:
type: integer
example: 10
d10:
type: integer
example: 9
d10x:
type: integer
example: 9
d12:
type: integer
example: 8
d20:
type: integer
example: 6
weight:
type: object
properties:
d4:
type: integer
example: 300
d6:
type: integer
example: 300
d8:
type: integer
example: 340
d10:
type: integer
example: 350
d10x:
type: integer
example: 350
d12:
type: integer
example: 350
d20:
type: integer
example: 400
sizes:
type: object
properties:
d4:
type: integer
example: 1
d6:
type: integer
example: 1
d8:
type: integer
example: 1
d10:
type: integer
example: 1
d10x:
type: integer
example: 1
d12:
type: integer
example: 1
d20:
type: integer
example: 1
sounds:
type: array
example:
-
src: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://cdn.dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
items:
type: object
properties:
src:
type: string
example: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on':
type: string
example: die.collide
uniforms:
type: object
properties:
number:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.424
r:
type: number
example: 0.463
diffuse:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.929
r:
type: integer
example: 1
values:
type: object
properties:
d4:
type: array
example:
- 1
- 2
- 3
- 4
items:
type: integer
d6:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
items:
type: integer
d8:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
items:
type: integer
d10:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
items:
type: integer
d12:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
items:
type: integer
d20:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
items:
type: integer
d10x:
type: array
example:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
items:
type: integer
id:
type: string
example: est-eaque
name:
type: string
example: Prof.
label:
type: object
properties:
color:
type: string
example: '#000000'
background_color:
type: string
example: '#e3d12d'
version:
type: string
example: 1.0.0
textures:
type: array
example:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
items:
type: object
properties:
src:
type: object
properties:
d4:
type: string
example: u_numberMap.png
d6:
type: string
example: u_numberMap.png
d8:
type: string
example: u_numberMap.png
d10:
type: string
example: u_numberMap.png
d12:
type: string
example: u_numberMap.png
d20:
type: string
example: u_numberMap.png
d10x:
type: string
example: u_numberMap_d10x.png
binding:
type: string
example: u_numberMap
api_version:
type: string
example: '1.0'
description:
type: string
example: 'Cumque aut ullam omnis ipsum cum nesciunt illum. Qui officia illo itaque quaerat possimus molestiae enim.'
user:
type: object
properties:
username:
type: string
example: gbayer
uuid:
type: string
example: 333d81c6-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Joaquin Ward'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
tags:
- 'Dice Box'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
limit:
type: number
description: ''
example: 16.459013781
filter:
type: string
description: ''
example: non
'/api/1.0/dice-box/{slug}':
get:
summary: 'Get Dice Box Theme'
operationId: getDiceBoxTheme
description: "\n\nGet information about a theme in your **Digital Dice Box**."
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
meshes:
d4: 'https://cdn.dddice.com/mesh/d04.fbx'
d6: 'https://cdn.dddice.com/mesh/d06.fbx'
d8: 'https://cdn.dddice.com/mesh/d08.fbx'
d10: 'https://cdn.dddice.com/mesh/d10.fbx'
d10x: 'https://cdn.dddice.com/mesh/d10.fbx'
d12: 'https://cdn.dddice.com/mesh/d12.fbx'
d20: 'https://cdn.dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://cdn.dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: magnam-magnam-minima
name: Miss
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Impedit vel nisi nihil saepe deleniti. Accusamus nam aut ex assumenda. Ipsa ab unde eveniet sunt natus.'
user:
username: jeromy.howe
uuid: 33429824-6054-11ee-8c15-000d3a9285ca
name: 'Mrs. Stacy Ortiz'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
properties:
data:
type: object
properties:
meshes:
type: object
properties:
d4:
type: string
example: 'https://cdn.dddice.com/mesh/d04.fbx'
d6:
type: string
example: 'https://cdn.dddice.com/mesh/d06.fbx'
d8:
type: string
example: 'https://cdn.dddice.com/mesh/d08.fbx'
d10:
type: string
example: 'https://cdn.dddice.com/mesh/d10.fbx'
d10x:
type: string
example: 'https://cdn.dddice.com/mesh/d10.fbx'
d12:
type: string
example: 'https://cdn.dddice.com/mesh/d12.fbx'
d20:
type: string
example: 'https://cdn.dddice.com/mesh/d20.fbx'
available_dice:
type: array
example:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
items:
type: string
physics:
type: object
properties:
inertia:
type: object
properties:
d4:
type: integer
example: 5
d6:
type: integer
example: 12
d8:
type: integer
example: 10
d10:
type: integer
example: 9
d10x:
type: integer
example: 9
d12:
type: integer
example: 8
d20:
type: integer
example: 6
weight:
type: object
properties:
d4:
type: integer
example: 300
d6:
type: integer
example: 300
d8:
type: integer
example: 340
d10:
type: integer
example: 350
d10x:
type: integer
example: 350
d12:
type: integer
example: 350
d20:
type: integer
example: 400
sizes:
type: object
properties:
d4:
type: integer
example: 1
d6:
type: integer
example: 1
d8:
type: integer
example: 1
d10:
type: integer
example: 1
d10x:
type: integer
example: 1
d12:
type: integer
example: 1
d20:
type: integer
example: 1
sounds:
type: array
example:
-
src: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://cdn.dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
items:
type: object
properties:
src:
type: string
example: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on':
type: string
example: die.collide
uniforms:
type: object
properties:
number:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.424
r:
type: number
example: 0.463
diffuse:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.929
r:
type: integer
example: 1
values:
type: object
properties:
d4:
type: array
example:
- 1
- 2
- 3
- 4
items:
type: integer
d6:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
items:
type: integer
d8:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
items:
type: integer
d10:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
items:
type: integer
d12:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
items:
type: integer
d20:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
items:
type: integer
d10x:
type: array
example:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
items:
type: integer
id:
type: string
example: magnam-magnam-minima
name:
type: string
example: Miss
label:
type: object
properties:
color:
type: string
example: '#000000'
background_color:
type: string
example: '#e3d12d'
version:
type: string
example: 1.0.0
textures:
type: array
example:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
items:
type: object
properties:
src:
type: object
properties:
d4:
type: string
example: u_numberMap.png
d6:
type: string
example: u_numberMap.png
d8:
type: string
example: u_numberMap.png
d10:
type: string
example: u_numberMap.png
d12:
type: string
example: u_numberMap.png
d20:
type: string
example: u_numberMap.png
d10x:
type: string
example: u_numberMap_d10x.png
binding:
type: string
example: u_numberMap
api_version:
type: string
example: '1.0'
description:
type: string
example: 'Impedit vel nisi nihil saepe deleniti. Accusamus nam aut ex assumenda. Ipsa ab unde eveniet sunt natus.'
user:
type: object
properties:
username:
type: string
example: jeromy.howe
uuid:
type: string
example: 33429824-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Mrs. Stacy Ortiz'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
tags:
- 'Dice Box'
patch:
summary: 'Update Dice Box Theme'
operationId: updateDiceBoxTheme
description: "\n\nUpgrade theme version in your **Digital Dice Box**."
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
meshes:
d4: 'https://cdn.dddice.com/mesh/d04.fbx'
d6: 'https://cdn.dddice.com/mesh/d06.fbx'
d8: 'https://cdn.dddice.com/mesh/d08.fbx'
d10: 'https://cdn.dddice.com/mesh/d10.fbx'
d10x: 'https://cdn.dddice.com/mesh/d10.fbx'
d12: 'https://cdn.dddice.com/mesh/d12.fbx'
d20: 'https://cdn.dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://cdn.dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: aut-aspernatur-quisquam
name: Mr.
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Odio ducimus quis enim aut et cupiditate. Cum fugiat veritatis eos ut. Optio non sit laboriosam voluptatem. Et ut sit hic.'
user:
username: thompson.patrick
uuid: 3345105f-6054-11ee-8c15-000d3a9285ca
name: 'Shania Graham'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
created_at: '2023-10-01T12:15:24.000000Z'
updated_at: '2023-10-01T12:15:24.000000Z'
properties:
data:
type: object
properties:
meshes:
type: object
properties:
d4:
type: string
example: 'https://cdn.dddice.com/mesh/d04.fbx'
d6:
type: string
example: 'https://cdn.dddice.com/mesh/d06.fbx'
d8:
type: string
example: 'https://cdn.dddice.com/mesh/d08.fbx'
d10:
type: string
example: 'https://cdn.dddice.com/mesh/d10.fbx'
d10x:
type: string
example: 'https://cdn.dddice.com/mesh/d10.fbx'
d12:
type: string
example: 'https://cdn.dddice.com/mesh/d12.fbx'
d20:
type: string
example: 'https://cdn.dddice.com/mesh/d20.fbx'
available_dice:
type: array
example:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
items:
type: string
physics:
type: object
properties:
inertia:
type: object
properties:
d4:
type: integer
example: 5
d6:
type: integer
example: 12
d8:
type: integer
example: 10
d10:
type: integer
example: 9
d10x:
type: integer
example: 9
d12:
type: integer
example: 8
d20:
type: integer
example: 6
weight:
type: object
properties:
d4:
type: integer
example: 300
d6:
type: integer
example: 300
d8:
type: integer
example: 340
d10:
type: integer
example: 350
d10x:
type: integer
example: 350
d12:
type: integer
example: 350
d20:
type: integer
example: 400
sizes:
type: object
properties:
d4:
type: integer
example: 1
d6:
type: integer
example: 1
d8:
type: integer
example: 1
d10:
type: integer
example: 1
d10x:
type: integer
example: 1
d12:
type: integer
example: 1
d20:
type: integer
example: 1
sounds:
type: array
example:
-
src: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://cdn.dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://cdn.dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
items:
type: object
properties:
src:
type: string
example: 'https://cdn.dddice.com/sounds/roll-1.mp3'
'on':
type: string
example: die.collide
uniforms:
type: object
properties:
number:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.424
r:
type: number
example: 0.463
diffuse:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.929
r:
type: integer
example: 1
values:
type: object
properties:
d4:
type: array
example:
- 1
- 2
- 3
- 4
items:
type: integer
d6:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
items:
type: integer
d8:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
items:
type: integer
d10:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
items:
type: integer
d12:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
items:
type: integer
d20:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
items:
type: integer
d10x:
type: array
example:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
items:
type: integer
id:
type: string
example: aut-aspernatur-quisquam
name:
type: string
example: Mr.
label:
type: object
properties:
color:
type: string
example: '#000000'
background_color:
type: string
example: '#e3d12d'
version:
type: string
example: 1.0.0
textures:
type: array
example:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
items:
type: object
properties:
src:
type: object
properties:
d4:
type: string
example: u_numberMap.png
d6:
type: string
example: u_numberMap.png
d8:
type: string
example: u_numberMap.png
d10:
type: string
example: u_numberMap.png
d12:
type: string
example: u_numberMap.png
d20:
type: string
example: u_numberMap.png
d10x:
type: string
example: u_numberMap_d10x.png
binding:
type: string
example: u_numberMap
api_version:
type: string
example: '1.0'
description:
type: string
example: 'Odio ducimus quis enim aut et cupiditate. Cum fugiat veritatis eos ut. Optio non sit laboriosam voluptatem. Et ut sit hic.'
user:
type: object
properties:
username:
type: string
example: thompson.patrick
uuid:
type: string
example: 3345105f-6054-11ee-8c15-000d3a9285ca
name:
type: string
example: 'Shania Graham'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
created_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
updated_at:
type: string
example: '2023-10-01T12:15:24.000000Z'
tags:
- 'Dice Box'
delete:
summary: 'Delete Dice Box Theme'
operationId: deleteDiceBoxTheme
description: "\n\nDelete a share request which will invalidate any shared URLs"
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
204:
description: ''
tags:
- 'Dice Box'
parameters:
-
in: path
name: slug
description: 'The slug of the dice box.'
example: illum
required: true
schema:
type: string
-
in: path
name: id
description: 'The ID of the theme.'
example: dddice-standard
required: true
schema:
type: string
/api/1.0/activate:
post:
summary: 'Create activation code'
operationId: createActivationCode
description: "When setting up an integration, it is advised to present a potential user with a \"code\"\nand then have the user enter that code on the official dddice website.\n\nThis is not only easy for the user to interact with, it also helps prevent odd handshakes\nand security barriers when trying to authenticate with cookies and/or other mechanisms,\nespecially when trying to authenticate inside an ``.\n\nWhen a code is returned, ask the user to navigate to [https://dddice.com/activate](https://dddice.com/activate)\nwhere they will be prompted to enter the code shown on your integrations screen."
parameters: []
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
data: []
properties:
data:
type: array
example: []
tags:
- 'Integration Authentication'
security: []
'/api/1.0/activate/{code}':
get:
summary: 'Read activation code'
operationId: readActivationCode
description: "While waiting for the user to authenticate, this endpoint can be used to retrieve the latest\nstatus of the activation code.\n\nIf a user is present, an integration can assume the user has successfully authenticated using\nthis code."
parameters:
-
in: header
name: Authorization
description: ''
example: 'Authorization: Secret secret-value'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data: []
properties:
data:
type: array
example: []
tags:
- 'Integration Authentication'
security: []
post:
summary: 'Authenticate activation code'
operationId: authenticateActivationCode
description: "After a user is prompted to enter a code, this (protected) endpoint is used to sync the\nrequesting user and secret/code together in order to activate the integration.\n\nThis request is typically not used directly when integrating with dddice."
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data: []
properties:
data:
type: array
example: []
tags:
- 'Integration Authentication'
parameters:
-
in: path
name: code
description: 'Activation code'
example: minus
required: true
schema:
type: string
tags:
-
name: Theme
description: "\nAPI for managing themes."
-
name: Room
description: "\nAPI for managing rooms."
-
name: Roll
description: "\nAPI for creating and managing dice rolls."
-
name: 'Share Dice'
description: "\nAPI for managing share requests."
-
name: User
description: "\nAPI for managing users."
-
name: 'Dice Box'
description: "\nAPI for managing themes in your **Digital Dice Box**."
-
name: 'Integration Authentication'
description: "\nAPI for authenticating with third-party applications and integrations"
components:
securitySchemes:
default:
type: http
scheme: bearer
description: ''
security:
-
default: []