Giter VIP home page Giter VIP logo

mybbbridge's Introduction

MyBBBridge

MyBBBridge is an extension aimed at making MyBB template and theme dev more convenant.

Warning: this software is pre-alpha. Make backups and use it at your own risk.

Features

  • Download themes (.css) and templates (.html) files from database to disk.

  • Save themes and templates to database when saved on disk.

  • Automatically refresh templates cache files on save.

How to use

Configuration

To operate, MyBBBridge needs a .vscode/mbbb.json file at your workspace root.

You can create one using the command MyBBBridge: Create config file.

The default config file looks like this:

{
    "database": {
        "host": "localhost",
        "port": 3306,
        "database": "mybb",
        "prefix": "mybb_",
        "user": "root",
        "password": ""
    },
    "mybbVersion": 1860,
    "mybbUrl": "http://localhost",
    "autoUpload": true
}
  • database: This one should be quite self explanatory!

  • mybbVersion: MyBB version to be used in newly created theme files. Existing files will keep their version metadata.

  • mybbUrl: URL of your MyBB board. Set to null or '' to disable cache refresh requests.

  • autoUpload: If true, MyBBBridge will try to save theme and stylesheets to database each time a corresponding file is saved in VSCode. Overrides existing database entries without confirmation!

Cache refresh

To be able to ask MyBB for template cache refresh, MyBBBridge requires you to upload the tiny cachecss.php php file of this repository to your web server, at the root of your MyBB directory. If you don't plan to use cache refresh, you can skip this step and set mybbUrl to null in your mbbb.json config file.

Commands

  • MyBBBridge: Create config file: Create a new config file, allowing you to start using MyBBBridge.

  • MyBBBridge: Load MyBB template set from database: Download and save all templates files of a given template set to the ./template_sets/<template_set_name>/ folder. Overrides existing files without confirmation!

  • MyBBBridge: Load MyBB style from database: Download and save all stylesheet files of a given style to the ./styles/<style_name>/ folder. Overrides existing files without confirmation!

Release Notes

0.0.1-alpha

Alpha release providing basic download features.

0.0.2-alpha

Alpha release with save features.

0.0.3-alpha

Alpha release allowing to refresh MyBB stylesheet cache files.

mybbbridge's People

Contributors

leminaw avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Forkers

metonator

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.