Code Monkey home page Code Monkey logo

wsc's Introduction

wsc

wsc is a web browser based chat client for dAmn-like chat servers. At the moment, the client only uses WebSockets as a transport, so to connect to dAmn's server using this client, a WebSocket proxy needs to be used.

Setup

  • Serve the CSS and javascript files in ./dist however you want.
    • File names containing .min. are minified versions of other sources.
    • Use the minified versions when deploying.
  • Serve the files in ./font on /font/ from the server, on port 80.
    • The CSS assumes the fonts are served here.

How To

Wsc is built as a jQuery plugin. The client itself draws the required HTML, but you must provide a containing div for the client. Here is the shortest example of how to use the client:

<html>
    <head>
        <title>Chat Example</title>
        <style type="text/css">
            .main {
                width: 100%;
                height: 100%;
            }
        </style>
        <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js"></script>
        <link rel="stylesheet" type="text/css" href="./dist/wsc.min.css" />
        <script type="text/javascript" src="./dist/wsc.min.js"></script>
        <script type="text/javascript">
            $(function() {
                $('.main').wsc( 'init', {
                    "server": 'ws://proxy.address',
                    "username": 'username',
                    "pk": 'token',
                    "autojoin": '#Channel'
                });
                // Start connecting to the WebSocket proxy.
                $('.main').wsc( 'connect' );
            });
        </script>
    </head>
    <body>
        <div class="main">
        </div>
    </body>
</html>

There are more configuration options, which will be documented later.

Socket.IO

Wsc can be used with socket.io. The only thing you need to do to use socket.io with wsc is load socket.io into your web page.

wsc's People

Contributors

divinityarcane avatar

Watchers

Joshua Blume avatar

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.