Skip to content

Commit

Permalink
Update the README with updated information
Browse files Browse the repository at this point in the history
  • Loading branch information
carlbennett committed Jul 1, 2016
1 parent 85b8058 commit 8bfd89c
Showing 1 changed file with 28 additions and 15 deletions.
43 changes: 28 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,58 @@
# BNCSUtil
## Preface
**BNCSUtil** is the **B**attle.**N**et **C**hat **S**ervice **Util**ity which
aids applications trying to logon to Battle.net™ v1 using the binary
aids applications trying to logon to Classic Battle.net™ using the binary
protocol. Specifically, BNCSUtil has functions that help with the cryptography
of game versions, keys, and passwords.

## Installing
Simply place the .so or .dll file in the same directory as the application that
wishes to use it. If this does not work, install the file into the system
Simply place the `.so` or `.dll` file in the same directory as the application
that wishes to use it. If this does not work, install the file into the system
library directory.

On Windows, this directory is:
### Windows
Copy the file to:

```
C:\Windows\System32
```

On Linux, this directory is:
### Linux
If you just have the `.so` file, copy it to:

```
/usr/lib/
```

And run:

```
sudo ldconfig
```

If you have just compiled from source, run this instead:

```
sudo make install
```

## Building
### Windows
The official build of BNCSUtil for Windows is produced using Visual Studio 2005
using the solution file in the `vc8_build` folder. The `vc7_build` is no longer
officially used or supported.
using the solution file in the `vc8_build` folder.

BNCSUtil requires GMP.

### Linux
To build:
```
./configure
cd src/bncsutil
make clean
make
make install
```

If you have a fresh checkout or are having build-related issues, run the
following to (re)generate the configure script:
```
autoreconf -if
```
If you are having build related issues, ensure that:

Note that to use `autoreconf` you will need to have GNU `autotools` installed.
- You have the `gcc` package installed.
- You have the `glibc` development package installed.
- You have the `gmp` development package installed.

0 comments on commit 8bfd89c

Please sign in to comment.