From Alcugs

Contents 1 Uploading your new age to ULM 1.1 Before you start 1.1.1 A ULM Account 1.1.2 FTP Server Space 1.1.3 A (Pre)Registration of your age 1.2 Preparing the files 1.3 Performing the library submission 1.3.1 Entering Basic information 1.3.2 Setting the LinkInPoints 1.3.3 Selecting the files 1.3.4 Configuring the mirrors 1.3.5 Submit 1.4 Managing your age on the ULM website 1.4.1 A bit of extra info 1.4.2 My Ages 1.4.3 Managing your Age 1.4.3.1 Version management 1.4.3.1.1 Deleting a version 1.4.3.1.2 General version information 1.4.3.1.3 Files and Checksums 1.4.3.1.4 Mirrors 1.4.3.1.5 Linking Panels 1.4.3.2 Selecting Maintainers 1.4.3.3 Transferring ownership and removing your age 1.4.4 My Profile 1.4.5 Members 1.4.5.1 User Info 1.4.5.2 Private Messaging 1.4.6 Moderators and Admins

Uploading your new age to ULM

So, you have the first version of your new age done, and you want to share it with the rest of the world? Very good!

The following guide will help you to upload your age to the Uru Library Manager:

Before you start

Before you can start you will need to have the following things ready:

A ULM Account

You will need an account at the main ULM library at [http://ulm.hbyte.net/])

At the main screen you can select Register, below the main navigation bar, or you can click on any link, to prompt a login box. At the login box there is also a link to the registration form.

FTP Server Space

ULM does not provide the space for you to put your age on, but merely provides a centralized downloading environment.

ULM can have a list of websites where your age is stored, both FTP and HTTP locations are supported.

Virtually all providers of HTTP web space, have an FTP account that is used for uploading files to the server space, and ULM has a feature that automatically uploads the correct files to your servers space.

ULM requires the following information of your web page:

• Download location (FTP or HTTP) where users can download the age
• Upload location ot which the program should upload the ages.
  • User name and password for the upload location (these are not stored anywhere in the ULM database!!)

You can also choose to manually upload the age files to your server space. It is required to place all files in one folder. Do not copy the folder structure found within your game folder!

If you need ftp space and cannot find it, contact Trylon trylon@hbyte.net] through mail or PM on the Alcugs forums, or if he is unavailable any other member of the community

A (Pre)Registration of your age

To ensure that no one besides you, and people you select as maintainers can upload and manage your age, you can only upload an age with a name that is registered to you.

Now, of course, before you have uploaded an age, you cannot have the age registered to you yet, so ULM has the concept of "preregistration", where you can reserve the use of an age name for two weeks, if you upload your age within that time, the age is registered as yours. If you do not preregister an age before uploading the upload will fail.

After you log in you can make a preregistration on the My Ages screen, where the preregistration box will probably be the only box you can see at that moment.

Be sure to use the same name as in your .age file.' ULM keys on the names of the .age files (without the .age extension). (You can enter the full name later) For example, if your .age file is called Pahts.age, enter "Pahts" in the preregistration field

Preparing the files

Throughout this guide I will assume that you will use ULM's built in upload
feature to upload your age, rather than doing a manual upload, if you however 
choose to do a manual upload, you will need to follow most of the steps here,
but just omit the upload credentials when specifying mirrors

To successfully upload an age to ULM, it must already be playable on your Uru: Complete Chronicles installation through ULM. If not, please copy all the necessary files to the Uru folder in which ULM is installed, and try playing them first. (Your age will be listen in ULM under the "Personal" Ages, and have a blue book)

If your age is playable, and performs satisfactory, the files are ready for upload. Be sure to know which files belong to your age, as you will have to select them manually!

Performing the library submission

Now we will submit the age for public download. First go to the Public Library Submission screen in ULM, by pressing the button "Public Library Submission" button on the lower left of the ULM main screen.

You will now be in a new screen, the NewVersionEditor screen:

Here you can enter all the information needed for your new version.

Entering Basic information

First you must select the age you want to update, so click on the topmost field labeled "New version of age:", and select your age. If the age is not yet in the ULM database, the age will have an asterisk (*) in front of the name. If you are preparing an update to an existing age, it will not have an asterisk in front of the name.

Now, When you are preparing an update to an existing age, you can select a previous version in the field below it (the latest version of the age will be selected by default) and click on the button Copy... that is next to it, in order to copy the details of that version, so you'll only have to enter the changes (if any files must be added or removed), and provide the upload info in the mirror screen.

Important: When preparing a brand new age submission, you can press the Copy... button in order to have the Link In Points copied from the local settings. This will usually only be the default linkinpoint, unless you manually added linkinpoints in the "Show Book Info" or "Age Properties" screen of the age. (Right mouse button on selected age).

Now, please enter the following details for your age in the upper right corner:

• Full name - The full name of your age, how it should be displayed in ULM
• Maintainer - The In Cavern name of the person or group responsible for maintaing the age
• Description - A short In Cavern description of the age.

For this version of your age, you can also put in a short version description in the Version Info -> Description field.

Setting the LinkInPoints

In the Links box, you can enter of change the LinkInPoints for your age. If you pressed the Copy... button, the LinkInPointDefault will probably already be entered.

Enter a new name in the LinkInPoint field, and fill in the following details:

• Description - The descriptive name of the link that will be placed in the book
• Link Image - Unused as of yet, will in the future hopefully be used to specify the linking image
• Condition - Unused, you can use this to add a Tag to the linkinpoint

Press the Add button to add the new LinkInPoint.

By selecting a LinkInPoint and pressing Delete, you can delete the LinkInPoint from the list. By selecting a LinkInPoint, modifying the details, and pressing the Modify button, you can change the LinkInPoint.

Selecting the files

Now we will take a better look at the Files group.

You can see Five tab pages, used to select the different kinds of files your age can use. The rightmost one, Link Image Files is not yet used.

In each tab, you can select files from the corresponding folder, by pressing , and delete them by pressing . You can add multiple files at once, and delete one at a time.

Important: You can only add files from the folder that is opened when pressing the button!

The files you should add in the different tabs are:

• Dat Files: All relevant age files (.age, .prp,.sum,.p2f) from the .dat folder.
• SDL Files: State Description Language files from the SDL sub folder
• Python Files: Python .pak files from the Python sub folder
• Sfx Files: Sound files from the SFX sub folder
• Link Image Files: Unused.

Important: When submitting an update based on a previous version, be sure that you delete all references to nonexistent files, to avoid error messages!!!!

Configuring the mirrors

Now we will configure the mirrors, this will be done in the File Mirrors box.

Important: when copying info from a previous version, the Upload location and Credentials are not saved,, so you'll have to enter them manually, by modifying the exiting entries.

For each mirror you want to copy to, enter the following:

• Download at - The download location, in URL style (e.g. http://myserver.com/my/url or ftp://myanonymousserver.com/path/to/basepath ) Always suffix this path with a name unique for this version e.g. "/version3"
• Upload ftp:// - The upload ftp url, also in URL style (ftp://myserver.com/path/to/agestorage) Always suffix this path with a name unique for this version e.g. "/version3"
• FTP user - your ftp user name
• FTP pass - your ftp password

Now, you can either press the Upload age to ftp mirrors button to start the upload now (also handy if you forgot to put in uploads on a previous submission), or have it uploaded on submission.

Important Note: Be sure to give a new path that is only for this version of your age. You should NOT overwrite files for a version of an age that is already registered, as that will prevent people from downloading a previous version, but in a wrong way. If you do not wish people to download a previous version of your age, delete that version through the ULM web interface.

Submit

Now, all that is left is to enter your ULM user name and password into the fields in the Export Data box, and press Submit to server

Should there still be things you want to change, you can do so in the ULM web interface

Managing your age on the ULM website

If you have uploaded an age, you already have an account, so use it to log in to the ULM main website [1].

On the main screen (even before login), you will see a list of ages in order of their last update. Progressing any further on the website will prompt a login screen.

You will see four main pages:

• Home - The home screen that lists all ages and pending preregistrations.
• My Ages - The portal to managing your ages
• My Profile - Change your public profile here
• Members - A list of members

A bit of extra info

Internally in the ULM back-ends, a submitted age is known as a Book' or a Descriptive Book. A version of an age is known as a Page or a Descriptive Page.

While the front ends do not generally use these terms, they sometimes could have slipped by, and show these terms.

My Ages

When you progress to My Ages, you will be presented with a list of your ages and preregistrations (if any), and given the opportunity to preregister a new age.

Since you have recently submitted a new library entry, you will have an age listed here. Click on it's name to go to the management page of that age

Managing your Age

You will now be on the page where you can change and see the basic description of your age

The top box provides a summary of your age In this summary you can change the following fields:

• Full name - The full name of your age, which will be displayed in ULM
• Maintainer Tag (IC) - The In Cavern owner tag, aka. the person/group that wrote/found/manages the age in your back story.
• Description - The short description of your age.

Version management

The main Age management screen gives you a list of available versions of your age. These are the versions that ULM provides to the users as possible versions to download and have.

Click on the version number (left) to go to the version management screen.

Deleting a version

You may have noticed a Remove Page button, which removes the version of the age. You need to enter your password in the field besides it in order to perform the removal. This is to avoid abuse or accidental removal.

When should I remove an version? Generally, the answer is never!

While you may be tempted to remove a version of your age when you feel it should no longer be downloaded, you should always remove the download mirrors instead.

This way, ULM will still be able to tell users of an old version that they have an outdated version. If you remove the version, users who have that version installed, will see the "Broken book" icon, and think that their install is corrupted.

If it is your intention to remove the version of your age from existence, and strongly encourage people to download a new version, by making an old version appear broken, go ahead, and remove it. Please consider that this action cannot be undone, before performing the removal.

Also, when a large number of old versions of your age exist, it is acceptable to remove a few of the oldest versions.

General version information

If you have entered the version management page, you will again notice a summary box on top of the page, here you can change:

• The version number - Not recommended unless you know what you are doing.
• The description of this version

Files and Checksums

Below the summary box you can see a list of files associated with this version, and the MD5 sums of the files. The MD5 sum is encoded in Base64, without removal of the last character.

If you notice that ULM wrongly displays your age as broken, you can use the Show Book Info or Age Properties button, to show how the files differ in checksum from the files it expects. This screen in the ULM main program allows you to see the checksum ULM sees for the file, so you can update the information here.

You can change the filename and MD5 sum, as well as the Filetype, which indicates in which uru sub-folder the file must be placed.

You can also add a file to the list here if you need to.

Mirrors

The following list provides you with the various download mirrors you have provided. You can change, remove or add mirrors here.

Linking Panels

Linking Panels or Link In Points are also manageable from here. You can change the LinkInPoint, Descriptive title, and (when ULM supports it) Linking panel image.

Selecting Maintainers

Back to the Age Management screen, you may have noticed a blue field, in which you can add and manage "maintainers".

As a number of ages are in fact a team effort, they may require more than one person who is allowed to make changes and updates. To facilitate this, you can select people as maintainers, users who can update and change age information just as you can do that.

You can also make someone a maintainer for a limited time only, and have his permissions revoked automatically when that time has passed.

Maintainters cannot appoint maintainers, change ownership or remove an age.

Transferring ownership and removing your age

The final (yellow) field, on the bottom of the page, allows you to transfer this age to another owner, or to remove this age. (Internally, this is the same process, as deleted ages are simply transferred to a hidden user. Only Admins can restore or permanently that age.)

Note that you'll need to provide your password in order to perform these actions, as they are irrevocable to a normal user.

My Profile

In the screen My Profile, you will be able to change your public information and email address, as well as change your password, and have a list of permissions you have for the various ages.

Your email address is not made public, and only used to contact you by Admins, or through Private Message.

All other info can be seen by all users.

Members

In this screen you can see a list of all members. By clicking on their name, you will be taken to their profile page.

User Info

On the user info screen, you can see the information they provided.

Private Messaging

You can also use this screen to send a private message to this user. It will be sent in an email to him/her, to the email address provided. If you do not select the Hide my email check box, your email address will be provided in that message, to facilitate easy communication.

Moderators and Admins

ULM supports users with more privileges than normal users.

Moderators:

• Are shown in blue on the members list.
• None or more users have Moderator status.
• Can change information about any age.
• Can manage maintainers of an age.
• Cannot see your email address or change your info.
• Cannot restore a deleted age.
• Cannot transfer ownership or delete an age.
• Cannot grant new Moderator permissions
• Could be moderator for only a limited time.

Admins:

• Are shown in orange on the members list.
• One or more users have Admin status.
• Can change information about any age.
• Can manage maintainers of an age.
• Can see your email address and change your info.
• Can restore a deleted age.
• Can transfer ownership or delete an age.
• Can grant new Moderator permissions.
• Cannot grant new Admin permissions.

Root Admin:

• Is shown as a normal Admin
• Has the user name 'root'
• Can also grant new Admin permissions

So, in summary: If you need help with managing your ages: information, versions or moderators, contact a Moderater (if any). If you need anything beyond that, contact an admin.

--Trylon 11:20, 21 September 2007 (CEST)