Giter Club home page Giter Club logo

open5e's Introduction

Open5e logo

Open5e

https://open5e.com
Site for browsing open D&D 5e content


API homepage

API   •   Discord   •   Patreon

Introduction

Open5e is a community project driven by a small number of volunteers in their spare time. We welcome any and all contributions!

Useful places to check out:

Development

Open5e uses the Nuxt3 framework for Vue3, which takes care of a lot of the architectural work for the frontend layer while allowing a large amount of flexibility.

5e game content is fetched from the open5e API running at https://api.open5e.com. This can be redirected using the environment variable API_URL.

Build Setup

Install dependencies.

npm install

Run the page in development mode.

npm run dev

Build for production and launch server.

npm start

Generate static project for publishing.

npm run generate

For detailed explanation on how things work, checkout the Nuxt.js docs.

open5e's People

Contributors

aciddrain avatar athaman avatar augustjohnson avatar bgotink avatar calumbell avatar cameronblandford avatar christophermiles avatar daveycakes avatar dependabot[bot] avatar dprothero avatar eepmoody avatar enkryptor avatar jaklein avatar jasonmcalpin avatar lackhand avatar markrmessmore avatar matthias-noetzli avatar maxrothman avatar michaeleconomy avatar nstefanski avatar oganm avatar panoramicpanda avatar pj4533 avatar pjmcnally avatar pvanduyse avatar realdeuce avatar snan avatar sturlen avatar taormina avatar tetra-cube avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

open5e's Issues

Improve search

Right now the search is only sort of useful.

  • It doesn't handle phrases or stemming well
  • no autocomplete (even for titles)

Switch to different search

To make sure we aren't limited by our 1 server, we should use some alternative search service, probably Google Custom Search.

Make custom 404 page

Currently, we serve S3's default 404 page, which is ugly. We'd like a custom 404 page that is:

  • funny
  • on-brand
  • provides an actionable way for users to get moving again, (e.g. link to the home page, highlighting the search)

Add "quick jump" feature

Hit a keyboard shortcut or click a button and start typing. Will autocomplete with available titles/searches and allow the user to choose one, jumping there.

Custom sidebar directives

Right now, making a sidebar looks like this:

.. sidebar:: Sage Advice
    :class: official

    **Is the Dueling fighting style intended to support a shield?**

    Yes. A character with the Dueling option usually
    pairs a one-handed weapon with a shield, a spellcasting
    focus, or a free hand.

    .. rst-class:: source

    Source: `Sage Advice Compendium <http://media.wizards.com/2015/downloads/dnd/SA_Compendium_1.01.pdf>`_

It'd be nice to have some that worked like this:

.. official::
    :source: `Sage Advice Compendium <http://media.wizards.com/2015/downloads/dnd/SA_Compendium_1.01.pdf>`_
    :question: Is the Dueling fighting style intended to support a shield?

    Yes. A character with the Dueling option usually
    pairs a one-handed weapon with a shield, a spellcasting
    focus, or a free hand.

:question: should be optional.

Tarrasque

STR should be 30, not 3 (bonus is correct)

TODO before launch

  • merge styling
  • update readme
    • make installation instructions for windows/mac
    • add travis badge
  • make sure we're good on the RTD theme license
  • merge #30

one more stat block - Solar

missing | before CHA

(Sorry I'm not doing a pull request.. I've pulled out all the individual monsters into files instead of the combined angels/golems and whatnot)

Add "area" field to spells in JSON that don't have it set

This is complicated by the diversity of area types and ambiguities around the proper sorting of them. E.g. you want to see 100-foot rays near 100-foot lines, but one is range: self area: 100-ft line and the other is range: 100ft. How should spheres with range (e.g. Fireball) be sorted vs those? and so on

Add sidebars

Current types:

  • errata
  • clarification

Use the sidebar directive and mark their type with :class:

Review page designs

Right now, our page designs (not layout, but how we put markup and text on the page) tries to mirror the SRD pretty closely. We should go through the pages and see if we can improve on it.

Turn on CDN

Stick a CDN in front of the site with a reasonable cache time (30M?)

NB: don't do this until the last minute

Add analytics

Add some kind of analytics so we know who's hitting the site from where

add * to archmage spells

fix spell list to show ones that he will cast on self. mage armor should be marked.

Remove __ on last spell with ** after it. it is broken.

match pdf

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.