npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

cloudscript-engine

v0.0.11

Published

NodeJS based PlayFab CloudScript engine

Downloads

9

Readme

Build Status Tests NPM Version

cloudscript-engine

Node.js based Framework to simplify PlayFab's Cloudscript handlers development.

Key features:

  • Run and debug your handlers locally using actual PlayFab title database
  • Pack your handlers in just one file bundle
  • Deploy your handlers easily

Why ?

If you have developed games using PlayFab backend, you know that you start with simple Cloudscript functions. As the game gets more complex, so does your Cloudscript.

Unfortunately, PlayFab doesn't provide a good way to develop or debug your functions. The naive way is to edit directly in Cloudscript web editor or to keep uploading development revisions full of Logs, and watch those Logs to see what's going on.

This is extremely inefficient and error prone.

Additionally, you may want to Unit Test your Cloudscript functions. But this is not easy job because Cloudscript functions rely on a set of globals that get automagically set for you at runtime. To use any modern standard test framework you need isolation and modularity.

On the other hand, Node.js provides an excellent environment to execute javascript (and Cloudscript is nothing but javascript). Node.js also provides a proven module stack and a huge amount of tools.

If we could only write Cloudscript handlers as node modules, where all the contexts are function parameters, and have tools to pack and upload to PlayFab Cloudscript format, then we would be able to version control, write tests, run locally, debug, release management, etc.

This is exactly what cloudscript-engine module does.

It requires you to write your handlers as node modules with a fixed function signature, and in exchange clears the way to agile development and project complexity management.

Installation

Add cloudscript-engine to your list of dependencies in package.json:

$ npm install cloudscript-engine  

Setting up credentials file

Create a file named credentials.json containing your secret keys by title as follows:

{
	"TITLE_1": "TITLE_1_SECRET",
	"TITLE_2": "TITLE_2_SECRET"
}

Execute cloudscript-engine

In order to have cloudscript server running, just execute

$ csengine -t <YOUR_TITLE> <PATH_TO_YOUR_HANDLERS_FILE>
Cloudscript Engine running at http://localhost:3000

Where:

  • YOUR_TITLE is the name of the PlayFab title you want to use. It must be present in your credentials file
  • PATH_TO_YOUR_HANDLERS_FILE is the path to your handlers' entry point (usually an index.js file).

See Handler example for additional information regarding handlers format and implementation.

Now you only have to change your PlayFab client to use the localhost endpoint

Extended documentation

More deep knowledge on how to use cloudscript-engine see Github wiki here