Project has moved to a scoped repo! 🎉

[GreenImp]

Hi everyone! 👋

What's happened?

This project has just been moved from my personal account (@GreenImp), to a new GitHub organisation (@dice-roller).
So, instead of being at
https://github.com/GreenImp/rpg-dice-roller
it's now at
https://github.com/dice-roller/rpg-dice-roller

The documentation has also moved to https://dice-roller.github.io/documentation

I want to assure you that the code hasn't changed, the license is still MIT, and the library is and always will be 100% free and open source! I am still maintaining the library, and nothing has changed, except for some ever so slight rebranding on the documentation.

Why this change?

The reason for this change is purely so that I can keep all of the dice roller repos under one roof, so they're easer to manage.

What does it mean?

The old git repos will automatically re-direct to the new ones. But the documentation doesn't appear to, which is a pain - I thought it would.

The NPM package names have also changed, and they are now "scoped" to the organisation. The old packages have been marked as "deprecated", so you'll get a warning when installing them.

⚠️ This is a big change, and it's important to note that you'll no longer get updates using the old package names, so you'll have to change the name in your package.json file!

Here are the deprecated package names, and what they are now:

• rpg-dice-roller -> @dice-roller/rpg-dice-roller
• vue-rpg-dice-roller -> @dice-roller/vue
• vuepress-plugin-dice-roller -> @dice-roller/vuepress-plugin-dice-roller

You'll also need to update the references in your code where you import or require the library:

import DiceRoller from 'rpg-dice-roller';

Becomes:

import DiceRoller from '@dice-roller/rpg-dice-roller';

Installing the new packages

To install the new packages, you'll need to first remove the old ones. i.e:

npm remove rpg-dice-roller

And install the new ones. i.e:

npm i @dice-roller/rpg-dice-roller

What next?

The documentation has been updated to match the new package names, so if you notice anything out of place, please let me know!

So the next step is for you to install the new packages and have fun 🥳