Hello and congratulations on your installation of YShout. This page is here to inform you of a hopefully successful installation. If you'd like to see if YShout has installed properly, mosey on over to the example YShout — if it's there, then everything has worked!

If the example does not appear, try chmodding everything inside the YShout directory to 777. This step is not required on all servers, but there are some for which it is imperative in order for YShout to be able to function.


To include YShout within your webpage, follow these instructions. First, add the following code to your <head> of a page you wish YShout to appear on. (make sure the path is correct):

<script src="yshout/js/jquery.js" type="text/javascript"></script>
<script src="yshout/js/yshout.js" type="text/javascript"></script>
<link rel="stylesheet" href="yshout/example/css/light.yshout.css" />

<script type="text/javascript">
   new YShout({
      yPath: ''

YShout can take a few arguments in its constructor, as shown below:

<script type="text/javascript">
	new YShout({
	   yPath: '',
	   log: 1

Lastly, add the following code where you want YShout to be displayed:

<div id="yshout"></div>

And that's it — you're all set, enjoy!


If you're not satisfied with the way YShout set up and would like to twiddle with some preferences, there is a control panel set up for that express purpose — the default password is fortytwo. You can configure many options from the control panel, as well as manage bans.

If you'd like to peruse through the previous messages, YShout 5 also includes a new and improved history viewer. In order to ban people and delete messages from the history, log into the control panel; once you're logged in, you will see little hover controls next to the messages, allowing you to manage the messages.

As for custom stylesheets, YShout comes with the example style, as well as two simpler ones: light and dark. These two are located in the example/css folder, and you can either use them directly, or modify them to your liking. View the light or the dark style.


If you have any questions or comments, feedback is always appreciated. I can be reached at yurivish@gmail.com, or at yurivish42 on AIM.