bitburner-src/src/Themes/README.md

# Themes

Feel free to contribute a new theme by submitting a pull request to the game!

See [CONTRIBUTING.md](/doc/CONTRIBUTING.md) for details.

## How create a new theme

1. Duplicate one of the folders in `/src/Themes/data` and give it a new name (keep the hyphenated format)
2. Modify the data in the new `/src/Themes/data/new-folder/index.ts` file
3. Replace the screenshot.png with one of your theme
4. Add the import/export into the `/src/Themes/data/index.ts` file

The themes are ordered according to the export order in `index.ts`

## Other resources

There is an external script called `theme-browser` which may include more themes than those shown here. Head over the [bitpacker](https://github.com/davidsiems/bitpacker) repository for details.
Move theme related things into its own subfolder This will make contributions easier and less prone to conflicts. 2022-01-19 13:02:58 +01:00			`# Themes`

			`Feel free to contribute a new theme by submitting a pull request to the game!`

Move markdown doc & quotes to ./docs subfolder 2022-01-26 11:13:38 +01:00			`See [CONTRIBUTING.md](/doc/CONTRIBUTING.md) for details.`
Move theme related things into its own subfolder This will make contributions easier and less prone to conflicts. 2022-01-19 13:02:58 +01:00
			`## How create a new theme`

			1. Duplicate one of the folders in `/src/Themes/data` and give it a new name (keep the hyphenated format)
			2. Modify the data in the new `/src/Themes/data/new-folder/index.ts` file
Add theme browser page accessible from game options Removed the themes buttons that were in the ThemeEditorModal and only left a "Revert to Default" button along with a link to the ThemeBrowser page. Split off the buttons into reusable components since they are now used in two pages. Display the themes in big cards with a zoomable screenshot. Applying the theme now shows a toast with an option to undo the action. The snackbar now allows ReactNode instead of only strings. - Add link with details on how to create a new theme in the game. - Add link to the theme-sharing discord channel. - Add icons to the theme & style buttons in GameOptions - Add "Theme Editor" button to ThemeBrowser - Add "Style Editor" button to ThemeBrowser - Move Styles related files into Themes folder - Includes a modal that shows a bigger version of the screenshot. - Change Snackbar to allow for ReactNode as the message 2022-01-19 15:49:08 +01:00			`3. Replace the screenshot.png with one of your theme`
			4. Add the import/export into the `/src/Themes/data/index.ts` file
Move theme related things into its own subfolder This will make contributions easier and less prone to conflicts. 2022-01-19 13:02:58 +01:00
			The themes are ordered according to the export order in `index.ts`

			`## Other resources`

			There is an external script called `theme-browser` which may include more themes than those shown here. Head over the [bitpacker](https://github.com/davidsiems/bitpacker) repository for details.