RolimirKal 61ed866480 v1.2
- File organization (unnecessary nesting.. oops)
	- ReadMe formatting
2025-08-11 03:05:25 -04:00
2025-08-11 03:05:25 -04:00
2025-08-11 03:05:25 -04:00
2025-08-11 03:05:25 -04:00
2025-08-11 03:05:25 -04:00
2025-08-11 03:05:25 -04:00

This is a locally hosted version of Andy Lawton's Bee's Dice Roller (built on Teal's dice roller).
	- Optomized for use as an OBS browser source

Setup:
	1. In OBS use the included index.htm file as a file URL ( file:///[path] ). Do not check 'Local file'.

		- Example URL:

			file:///C:/Documents/LocalBeeDie/index.htm

	2. Append the desired settings to the URL using a single question mark followed by params in the following format separated by ampersands:

			paramname=value

		- Example to make the dice red and automatically roll 1d20 on page load:

			file:///C:/Documents/LocalBeeDie/index.htm?dicehex=aa293c&roll&d=1d20

	3. Set the desired dice window size in OBS using the Width and Height settings.

	4. Check 'Refresh browser when scene becomes active'.

	5. Use chromahex param to set the background color and use an OBS filter on the source to chroma-key that color out.

		- Example:

			file:///C:/Documents/LocalBeeDie/index.htm?chromahex=00ff00&roll&d=1d20

	6. Toggle broswer source off and on to roll dice.

Param Options:

	Title			paramname		value		example				Description
	Dice Color		dicehex			hexcode		dicehex=ffffff		Color of the dice body material.
	Number Color	labelhex		hexcode		labelhex=000000 	Color of the numbers written on dice faces.
	Dice Opacity	transparency	0-1			transparency=0.5 	Transparency of the dice material.
	BG Color		chromahex		hexcode		chromahex=00ff00 	Window BG color.
	Dice Scale		dicescale		.05-4		dicescale=2 		Default scale is 1/10th the shortest window dimension
	Dice Shadow		shadows			0 or 1 		shadows=0 			1 for shadows, 0 for no shadows.
	Output Detail	resultdetail	null		resultdetail		Enables output per die in the backend.
	Output Total	resulttoal		null		resulttotal			Enables output SUM on backend.
	Depreciated		noresult		null		noresult			Disables output.
	Depreciated		resulthex		hexcode		resulthex=000000	Result popup text color.
	Depreciated		resultbghex		hexcode		resultbghex=ffffff	Result popup bg color.
	Depreciated		resultsize 		int			resultsize=16		Result popup font size.
	Auto Roll 		roll 			null 		roll 				Enables roll on page load.
	Dice 			d 				(int)d(int)	1d20				Dice selection in format [INTdINT+INTdINT]

		- extended dice notation example that rolls two 20 sided die, one 6 sided die, and two 4 sided die:

			2d20+1d6+2d4

changelog:
	v1.2
		- File organization (unnecessary nesting.. oops)
		- ReadMe formatting
	v1.1:
		- File cleanup
	v1:
		- set up files to run locally
		- added workaround for an occasional that prevents dice from loading (detects error and refreshes the window after a few seconds)
		- changed lighting for better readability
		- optomized some redundant code
		- new, more straightforward dice scaling method
		- made result popup invisible to enable backend functionality without visual disruption
			- this is a bad solution implemented during experimentation while learning what the code does.. I will probably be too lazy to fix it later
Description
Local version of Bee's Dice Roller
Readme 200 KiB
Languages
JavaScript 92.8%
CSS 3.6%
HTML 3.6%