Skip to content
This repository has been archived by the owner on Dec 30, 2024. It is now read-only.

Commit

Permalink
🚚 Update my username
Browse files Browse the repository at this point in the history
  • Loading branch information
Chasmical committed Dec 16, 2023
1 parent 69671ae commit 0c7966c
Show file tree
Hide file tree
Showing 20 changed files with 61 additions and 61 deletions.
40 changes: 20 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,51 @@
<div align="center">
<p>
<a href="https://sugarbarrel.github.io/RogueLibs">
<a href="https://chasmical.github.io/RogueLibs">
<img src="./img/RogueLibs.png" width=75% alt="RogueLibs"/>
</a>
</p>
<p>
<a href="https://github.com/SugarBarrel/RogueLibs/releases/latest">
<img src="https://img.shields.io/github/v/release/SugarBarrel/RogueLibs?label=Latest%20release&style=for-the-badge&logo=github" alt="Latest release"/>
<a href="https://github.com/Chasmical/RogueLibs/releases/latest">
<img src="https://img.shields.io/github/v/release/Chasmical/RogueLibs?label=Latest%20release&style=for-the-badge&logo=github" alt="Latest release"/>
</a>
<a href="https://github.com/SugarBarrel/RogueLibs/releases">
<img src="https://img.shields.io/github/v/release/SugarBarrel/RogueLibs?include_prereleases&label=Latest%20pre-release&style=for-the-badge&logo=github" alt="Latest pre-release"/>
<a href="https://github.com/Chasmical/RogueLibs/releases">
<img src="https://img.shields.io/github/v/release/Chasmical/RogueLibs?include_prereleases&label=Latest%20pre-release&style=for-the-badge&logo=github" alt="Latest pre-release"/>
</a>
<br/>
<a href="https://github.com/SugarBarrel/RogueLibs/releases">
<img src="https://img.shields.io/github/downloads/SugarBarrel/RogueLibs/total?label=Downloads&style=for-the-badge" alt="Downloads"/>
<a href="https://github.com/Chasmical/RogueLibs/releases">
<img src="https://img.shields.io/github/downloads/Chasmical/RogueLibs/total?label=Downloads&style=for-the-badge" alt="Downloads"/>
</a>
<a href="https://github.com/SugarBarrel/RogueLibs/subscription">
<img src="https://img.shields.io/github/watchers/SugarBarrel/RogueLibs?color=green&label=Watchers&style=for-the-badge" alt="Watchers"/>
<a href="https://github.com/Chasmical/RogueLibs/subscription">
<img src="https://img.shields.io/github/watchers/Chasmical/RogueLibs?color=green&label=Watchers&style=for-the-badge" alt="Watchers"/>
</a>
<a href="https://github.com/SugarBarrel/RogueLibs/stargazers">
<img src="https://img.shields.io/github/stars/SugarBarrel/RogueLibs?color=green&label=Stars&style=for-the-badge" alt="Stars"/>
<a href="https://github.com/Chasmical/RogueLibs/stargazers">
<img src="https://img.shields.io/github/stars/Chasmical/RogueLibs?color=green&label=Stars&style=for-the-badge" alt="Stars"/>
</a>
</p>
</div>

This modding library does nothing on its own, but it provides methods for other mods to easily create custom mutators, items, traits, status effects, abilities, unlocks, menus and even integrate custom sounds and sprites (yep, even TK2D ones)!

- **[Installation guide](https://sugarbarrel.github.io/RogueLibs/docs/user/installation)**
- **[Making mods with RogueLibs](https://sugarbarrel.github.io/RogueLibs/docs/dev/getting-started)**
- **[Installation guide](https://chasmical.github.io/RogueLibs/docs/user/installation)**
- **[Making mods with RogueLibs](https://chasmical.github.io/RogueLibs/docs/dev/getting-started)**

## [See RogueLibs' site for more info](https://sugarbarrel.github.io/RogueLibs)
## [See RogueLibs' site for more info](https://chasmical.github.io/RogueLibs)

### Links
- [Download RogueLibs (latest stable version)](https://github.com/SugarBarrel/RogueLibs/releases/latest)
- [Download RogueLibs (latest stable version)](https://github.com/Chasmical/RogueLibs/releases/latest)
- [Steam guide on modding with BepInEx](https://steamcommunity.com/sharedfiles/filedetails/?id=2106187116)
- [RogueLibs' site](https://sugarbarrel.github.io/RogueLibs)
- [RogueLibs' site](https://chasmical.github.io/RogueLibs)

### Contributing

If you have any suggestions or find any bugs, you can open a new issue here on GitHub, or create a pull request:

<div>
<a href="https://github.com/SugarBarrel/RogueLibs/issues/new/choose">
<img src="https://img.shields.io/github/issues/SugarBarrel/RogueLibs?color=green&label=Issues&logo=github&style=for-the-badge" alt="Open a new issue"/>
<a href="https://github.com/Chasmical/RogueLibs/issues/new/choose">
<img src="https://img.shields.io/github/issues/Chasmical/RogueLibs?color=green&label=Issues&logo=github&style=for-the-badge" alt="Open a new issue"/>
</a>
<a href="https://github.com/SugarBarrel/RogueLibs/compare">
<img src="https://img.shields.io/github/issues-pr/SugarBarrel/RogueLibs?color=green&logo=github&style=for-the-badge" alt="Create a pull request"/>
<a href="https://github.com/Chasmical/RogueLibs/compare">
<img src="https://img.shields.io/github/issues-pr/Chasmical/RogueLibs?color=green&logo=github&style=for-the-badge" alt="Create a pull request"/>
</a>
</div>

Expand Down
6 changes: 3 additions & 3 deletions website/blog/2021-08-18-roguelibs-v3.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: RogueLibs v3.1.0 released!
author: Abbysssal
author_title: Creator of RogueLibs
author_url: https://github.com/SugarBarrel
author_image_url: https://github.com/SugarBarrel.png
author_url: https://github.com/Chasmical
author_image_url: https://github.com/Chasmical.png
tags: [roguelibs, release]
description: Completely replaced the vanilla localization system.
image: https://i.imgur.com/XaNGCx7.png
Expand Down Expand Up @@ -67,7 +67,7 @@ Speaking of translations... **The vanilla translations are terrible**. I'm not s

And that's why RogueLibs will use community translations instead of official ones.

Feel free to contribute by checking the localization files yourself and making any necessary changes. The localization files are located [in here](https://github.com/SugarBarrel/RogueLibs/tree/main/RogueLibsCore/Resources). See more info on contributing to the project [here](https://github.com/SugarBarrel/RogueLibs/blob/main/.github/CONTRIBUTING.md).
Feel free to contribute by checking the localization files yourself and making any necessary changes. The localization files are located [in here](https://github.com/Chasmical/RogueLibs/tree/main/RogueLibsCore/Resources). See more info on contributing to the project [here](https://github.com/Chasmical/RogueLibs/blob/main/.github/CONTRIBUTING.md).

### Live Reloading

Expand Down
6 changes: 3 additions & 3 deletions website/blog/2021-08-31-what-i-hate-about-sor.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: What I hate about SoR
author: Abbysssal
author_title: Creator of RogueLibs
author_url: https://github.com/SugarBarrel
author_image_url: https://github.com/SugarBarrel.png
author_url: https://github.com/Chasmical
author_image_url: https://github.com/Chasmical.png
tags: [blog, sor2]
description: The code is really hard and wet.
hide_table_of_contents: false
Expand Down Expand Up @@ -52,7 +52,7 @@ For example, `Unlock` has three fields: `unavailable`, `onlyInCharacterCreation`

![unavailable, onlyInCharacterCreation and freeItem fields](https://imgur.com/gjnxvNM.png)

I spent **dozens of hours** converting that kind of system into something more maintainable: `Available`, `AvailableInCC` and `AvailableInItemTeleporter` - properties that you can find in RogueLibs. And even after that, [there still were issues](https://github.com/SugarBarrel/RogueLibs/issues/40). *I'm bad at discrete mathematics, that's why I had a hard time doing that.*
I spent **dozens of hours** converting that kind of system into something more maintainable: `Available`, `AvailableInCC` and `AvailableInItemTeleporter` - properties that you can find in RogueLibs. And even after that, [there still were issues](https://github.com/Chasmical/RogueLibs/issues/40). *I'm bad at discrete mathematics, that's why I had a hard time doing that.*

### Hard code

Expand Down
6 changes: 3 additions & 3 deletions website/blog/2022-01-30/roguelibs-v3.5.0-beta.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
title: RogueLibs v3.5.0 enters beta
author: Abbysssal
author_title: Creator of RogueLibs
author_url: https://github.com/SugarBarrel
author_image_url: https://github.com/SugarBarrel.png
author_url: https://github.com/Chasmical
author_image_url: https://github.com/Chasmical.png
tags: [roguelibs]
description: Information about the v3.5.0-beta
image: https://i.imgur.com/XaNGCx7.png
hide_table_of_contents: false
---

Today RogueLibs v3.5.0 enters a long beta, because there's a huge list of stuff that needs to be done before the release, mainly adding new custom interactions without adding more patches. You'll be able to download the beta version on [RogueLibs' releases page](https://github.com/SugarBarrel/RogueLibs/releases).
Today RogueLibs v3.5.0 enters a long beta, because there's a huge list of stuff that needs to be done before the release, mainly adding new custom interactions without adding more patches. You'll be able to download the beta version on [RogueLibs' releases page](https://github.com/Chasmical/RogueLibs/releases).

Just like the localization system in v3.1.0, v3.5.0 will completely replace the vanilla interactions system. The original code in these places is absolutely awful and inconsistent. So, we'll have to rewrite every single vanilla interaction to be moddable.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/dev/custom-sprites.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Custom Sprites and Resources

Adding image resources to a plugin is a bit tricky. Visual Studio loads any image resources as bitmaps, but we don't want that. You'll need to modify the resources manifest yourself, and add your images as binary files (or byte arrays). RogueLibs supports cropping and resizing your sprites, so, technically, you could even upload a spritesheet, and cut sprites out of it, but the performance gain would not be worth it (loading all of the 1204 64x64 sprites from [Sidi's spritepack](https://sugarbarrel.github.io/SoRModHub/) takes about 350 milliseconds, while patching methods is significantly slower - RogueLibs takes about 5 seconds to load).
Adding image resources to a plugin is a bit tricky. Visual Studio loads any image resources as bitmaps, but we don't want that. You'll need to modify the resources manifest yourself, and add your images as binary files (or byte arrays). RogueLibs supports cropping and resizing your sprites, so, technically, you could even upload a spritesheet, and cut sprites out of it, but the performance gain would not be worth it (loading all of the 1204 64x64 sprites from [Sidi's spritepack](https://chasmical.github.io/SoRModHub/) takes about 350 milliseconds, while patching methods is significantly slower - RogueLibs takes about 5 seconds to load).

import Tabs from '@site/src/components/Tabs';
import TabItem from '@site/src/components/TabItem';
Expand Down
2 changes: 1 addition & 1 deletion website/docs/dev/hooks/hooks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ If you want to attach hooks to instances right when they are initialized, use [H
## Examples {#examples}

:::info
Custom content classes (`CustomItem`, `CustomTrait`, `CustomEffect`, `CustomAbility` and others) are hooks, by the way. You can see the custom classes' implementation in [RogueLibs' source code](https://github.com/SugarBarrel/RogueLibs/tree/main/RogueLibsCore/Hooks).
Custom content classes (`CustomItem`, `CustomTrait`, `CustomEffect`, `CustomAbility` and others) are hooks, by the way. You can see the custom classes' implementation in [RogueLibs' source code](https://github.com/Chasmical/RogueLibs/tree/main/RogueLibsCore/Hooks).
:::

import CodeSnippet from '@site/src/components/CodeSnippet';
Expand Down
2 changes: 1 addition & 1 deletion website/docs/dev/interactions/create-interaction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -205,4 +205,4 @@ RogueInteractions.CreateProvider<Door>(static h =>

## Examples {#examples}

You can find a ton of examples [here](https://github.com/SugarBarrel/RogueLibs/tree/main/RogueLibsCore/Interactions/VanillaInteractions) (RogueLibs' source code, reimplementing the vanilla interactions).
You can find a ton of examples [here](https://github.com/Chasmical/RogueLibs/tree/main/RogueLibsCore/Interactions/VanillaInteractions) (RogueLibs' source code, reimplementing the vanilla interactions).
2 changes: 1 addition & 1 deletion website/docs/dev/items/create-item.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public class MyCustomItem : CustomItem
```

:::tip Pro-tip: String consts
Use static types with string consts, like `RogueCategories` and `ItemTypes`. This way you won't make a typo. Typos can be critical sometimes, since neither the game nor RogueLibs track all existing item categories *([although it's an interesting idea, maybe I'll do something like that](https://github.com/SugarBarrel/RogueLibs/issues/26))*.
Use static types with string consts, like `RogueCategories` and `ItemTypes`. This way you won't make a typo. Typos can be critical sometimes, since neither the game nor RogueLibs track all existing item categories *([although it's an interesting idea, maybe I'll do something like that](https://github.com/Chasmical/RogueLibs/issues/26))*.
:::

## Initialization {#initialization}
Expand Down
2 changes: 1 addition & 1 deletion website/docs/dev/names/custom-languages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ LanguageService.RegisterLanguageCode("japanese", (LanguageCode)123);
```

:::info Work-In-Progress
There hasn't been much progress on actually implementing custom languages. No one has ever translated the entire game to a different language, not yet included with SoR. When that time comes, feel free to [create an issue on GitHub](https://github.com/SugarBarrel/RogueLibs/issues/new/choose).
There hasn't been much progress on actually implementing custom languages. No one has ever translated the entire game to a different language, not yet included with SoR. When that time comes, feel free to [create an issue on GitHub](https://github.com/Chasmical/RogueLibs/issues/new/choose).
:::

## `LanguageService` {#languageservice}
Expand Down
6 changes: 3 additions & 3 deletions website/docs/dev/unlocks/configuring-unlocks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ public virtual Sprite GetImage() => RogueFramework.ExtraSprites.TryGetValue(Name
```

:::tip Pro-tip
You can see for yourself how these methods are implemented in [RogueLibs' source code](https://github.com/SugarBarrel/RogueLibs/blob/main/RogueLibsCore/Hooks/Unlocks/UnlockWrapper.cs).
You can see for yourself how these methods are implemented in [RogueLibs' source code](https://github.com/Chasmical/RogueLibs/blob/main/RogueLibsCore/Hooks/Unlocks/UnlockWrapper.cs).
:::

### `DisplayedUnlock`
Expand Down Expand Up @@ -100,7 +100,7 @@ public virtual string GetFancyDescription()
```

:::tip Pro-tip
You can see for yourself how these methods are implemented in [RogueLibs' source code](https://github.com/SugarBarrel/RogueLibs/blob/main/RogueLibsCore/Hooks/Unlocks/DisplayedUnlock.cs).
You can see for yourself how these methods are implemented in [RogueLibs' source code](https://github.com/Chasmical/RogueLibs/blob/main/RogueLibsCore/Hooks/Unlocks/DisplayedUnlock.cs).
:::

## Examples {#examples}
Expand Down Expand Up @@ -209,7 +209,7 @@ public class RandomItemsButton : ItemUnlock
</TabItem>
<TabItem value="categories">

So, you want to make categories, like in [aToM](https://github.com/SugarBarrel/aToM)? Here you go!
So, you want to make categories, like in [aToM](https://github.com/Chasmical/aToM)? Here you go!
```csharp title="MyCategory.cs"
public class MyCategory : MutatorUnlock
Expand Down
2 changes: 1 addition & 1 deletion website/docs/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl';

- <span style={{fontSize: "1.1em"}}>

Because it's really easy to use! Just check out some examples in [here](https://github.com/SugarBarrel/RogueLibs/tree/main/RogueLibsCore.Test/Tests).
Because it's really easy to use! Just check out some examples in [here](https://github.com/Chasmical/RogueLibs/tree/main/RogueLibsCore.Test/Tests).

</span>

Expand Down
8 changes: 4 additions & 4 deletions website/docs/user/installation.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Installation

To start using mods, first you need to install BepInEx, the modding framework that we're using to mod Streets of Rogue. Then, install RogueLibs (both plugin and patcher - two different important files) and then any mods that you want to play with. You can find a lot of mods on [SoR ModHub](https://sugarbarrel.github.io/SoRModHub) or [GameBanana](https://gamebanana.com/mods/games/8455).
To start using mods, first you need to install BepInEx, the modding framework that we're using to mod Streets of Rogue. Then, install RogueLibs (both plugin and patcher - two different important files) and then any mods that you want to play with. You can find a lot of mods on [SoR ModHub](https://chasmical.github.io/SoRModHub) or [GameBanana](https://gamebanana.com/mods/games/8455).

import Tabs from '@site/src/components/Tabs';
import TabItem from '@site/src/components/TabItem';
Expand Down Expand Up @@ -340,7 +340,7 @@ Click **OK** and run the game through Steam.
]}>
<TabItem value="v3">

**[Download the latest RogueLibs version](https://github.com/SugarBarrel/RogueLibs/releases/latest)**
**[Download the latest RogueLibs version](https://github.com/Chasmical/RogueLibs/releases/latest)**

You need to download only two files: `RogueLibsCore.dll` and `RogueLibsPatcher.dll`.

Expand All @@ -365,7 +365,7 @@ The directory is called **`patchers`**, it's different from **`plugins`**.
RogueLibs v2.x.x is outdated and is not compatible with new mods!
:::

**[Download the latest RogueLibs version](https://github.com/SugarBarrel/RogueLibs/releases/tag/v2.2-pre.2)**
**[Download the latest RogueLibs version](https://github.com/Chasmical/RogueLibs/releases/tag/v2.2-pre.2)**

You need to download only one file - `RogueLibs.dll`.

Expand All @@ -388,7 +388,7 @@ And put these `.dll` files in the `BepInEx/plugins` directory.

## Where can I get mods? {#mod-sources}

**[SoR ModHub](https://sugarbarrel.github.io/SoRModHub)** is a collection of mods that use the latest RogueLibs v3 that I know about. Includes links to other mod sources as well, and is updated pretty regularly.
**[SoR ModHub](https://chasmical.github.io/SoRModHub)** is a collection of mods that use the latest RogueLibs v3 that I know about. Includes links to other mod sources as well, and is updated pretty regularly.

**[GameBanana](https://gamebanana.com/mods/games/8455)** - Streets of Rogue's official mod-sharing place. Some mods don't get released or updated there, since the process of setting up or updating a page is way too long and overly complicated.

Expand Down
16 changes: 8 additions & 8 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
module.exports = {
title: 'RogueLibs Documentation',
tagline: 'Doing the impossible.',
url: 'https://sugarbarrel.github.io',
url: 'https://chasmical.github.io',
baseUrl: '/RogueLibs/',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
favicon: 'img/favicon.ico',
organizationName: 'SugarBarrel',
organizationName: 'Chasmical',
projectName: 'RogueLibs',
i18n: {
defaultLocale: 'en',
Expand All @@ -24,7 +24,7 @@ module.exports = {
plugins: ['docusaurus-plugin-sass'],
themeConfig: {
metadata: [
{ name: "twitter:image", content: "https://sugarbarrel.github.io/RogueLibs/img/logo.png" },
{ name: "twitter:image", content: "https://chasmical.github.io/RogueLibs/img/logo.png" },
],
docs: {
sidebar: {
Expand All @@ -38,7 +38,7 @@ module.exports = {
announcementBar: {
id: 'star',
content:
'<span style="font-size: 1rem;">⭐️ If you like RogueLibs, give it a star on <a target="_blank" href="https://github.com/SugarBarrel/RogueLibs">GitHub</a>! ⭐️</span>',
'<span style="font-size: 1rem;">⭐️ If you like RogueLibs, give it a star on <a target="_blank" href="https://github.com/Chasmical/RogueLibs">GitHub</a>! ⭐️</span>',
},
navbar: {
hideOnScroll: true,
Expand Down Expand Up @@ -73,7 +73,7 @@ module.exports = {
position: 'right',
},
{
href: 'https://github.com/SugarBarrel/RogueLibs',
href: 'https://github.com/Chasmical/RogueLibs',
position: 'right',
className: 'header-github-link',
'aria-label': 'GitHub repository',
Expand Down Expand Up @@ -106,7 +106,7 @@ module.exports = {
items: [
{
label: 'GitHub',
href: 'https://github.com/SugarBarrel/RogueLibs',
href: 'https://github.com/Chasmical/RogueLibs',
},
],
},
Expand All @@ -121,12 +121,12 @@ module.exports = {
docs: {
sidebarPath: require.resolve('./sidebars.js'),
editUrl:
'https://github.com/SugarBarrel/RogueLibs/edit/main/website/',
'https://github.com/Chasmical/RogueLibs/edit/main/website/',
},
blog: {
showReadingTime: true,
editUrl:
'https://github.com/SugarBarrel/RogueLibs/edit/main/website/blog/',
'https://github.com/Chasmical/RogueLibs/edit/main/website/blog/',
},
theme: {
customCss: require.resolve('./src/css/custom.css'),
Expand Down
Loading

0 comments on commit 0c7966c

Please sign in to comment.